BBjSessionInfo::getMessage

Description

In BBj 16.0 and higher, this method returns a user-defined message from the session described by this BBjSessionInfo.

Syntax

Return Value	Method
string	getMessage()

Parameters

None.

Return Value

This is the same string that would be returned by STBL("!SESSIONINFO").

Remarks

In BBj 23 and higher, if STBL("!SESSIONINFO") has not been set, this falls back to any value specified in BBjCommandLineObject::setMessage, or the equivalent command line option –message="message".

Example

rem ' BBjSessionInfo

info$ = stbl("!SESSIONINFO","Session Info Message")
info! = bbjapi().getCurrentSessionInfo()
print 'br',"bbjapi().getCurrentSessionInfo: ",'er',info!
print "getUser: ",info!.getUser()
print "getUnresponsiveTime:",info!.getUnresponsiveTime()
print "getIPAddress: ",info!.getIPAddress()
print "getConnectTime: ",info!.getConnectTime()
print "getProgramName: ",info!.getProgramName()
print "getProgramLine:",info!.getProgramLine()
print "getLineListing: ",info!.getLineListing()
print "isBackground: ",info!.isBackground()
print "getSessionID:",info!.getSessionID()
print "getTerminalID: ",info!.getTerminalID()
print "getTerminalName: ",info!.getTerminalName()
print "getMessage: ",info!.getMessage()

vector! = bbjapi().getSessionInfos()
size = vector!.size()
print 'br',"bbjapi().getSessionInfos:",'er'
for i = 0 to size - 1
    info! = vector!.get(i)
    print info!
next i
end