UserMgrGetSessionUser (FUN)ΒΆ

FUNCTION UserMgrGetSessionUser : RTS_IEC_HANDLE

Retrieves the user handle assigned to a CODESYS online session.

InOut:

Scope

Name

Type

Comment

Return

UserMgrGetSessionUser

RTS_IEC_HANDLE

Handle of the user or RTS_INVALID_HANDLE if not available.

Input

sessionId

UDINT

Session id of which the user handle should be read.

pResult

POINTER TO RTS_IEC_RESULT
Pointer to error code. One of:

  • ERR_OK: User is available

  • ERR_NOTINITIALIZED: The session management is not initialized

  • ERR_NO_OBJECT: The session is not available