Prototype
subroutine EcsGetCurrentSession(string:SessionShortName)
Description
Reports the current active session name.
Parameters
SessionShortName |
Output |
A string that will receive the single character session name of the currently active session. |
Return Value
ECS_E_NOTINIT |
Not initialized - command was ignored |
ECS_E_ERRORFREE |
No errors were generated |
Example
###*******************************
### Action to get current session
###*******************************
action GetCurrentSession is
call EcsGetCurrentSession ( ShortSessionName_SV )
copy errorlevel to ErrorLevel_IV
copy "EcsGetCurrentSession" to Call_SV
if ( ErrorLevel_IV = ECS_E_ERRORFREE ) then
copy "Active session is " ShortSessionName_SV to Message_SV
action DisplayMessage
else
action DisplayError
end if