BBjAPI::newBBjSession

Description

In BBj 4.0 and higher, this method starts a new BBj session.

Syntax

Return Value

Method

int

newBBjSession(BBjCommandLineObject cmdLineObj)

Parameters

Variable

Description

cmdLineObj

Represents the command line parameters used to start the new BBj session.

Return Value

Returns error code (0 = successful).

Remarks

The current session will not wait for the new BBj session to complete, much like an an SCALL.

Due to this, the error codes only represent problems encountered in starting the new session (ie: not enough memory, invalid parameters), not the release value of the new Session. If this is desired, use newSynchBBjSession(BBjCommandLineObject).

Example

rem Starting a new BBj Session with newBBjSession()

REM get my API Proxy
myAPI! = BBjAPI()

REM get my Current CommandLine object
myCFG! = myAPI!.getConfig().getCurrentCommandLineObject()

REM set my new program name
myCFG!.setProgramName("foo")

REM Run my new BBj Session with my CommandLine Object
x = myAPI!.newBBjSession(myCFG!)

See Also

BBjAPI

BBjAPI::newSynchBBjSession

BBjCommandLineObject

Object Variables

See the BBj Object Diagram for an illustration of the relationship between BBj Objects.