UserMgrObjectGetName (FUN)

FUNCTION UserMgrObjectGetName : RTS_IEC_RESULT

Get object name
Limited to the application subtree.
InOut:

Scope

Name

Type

Comment

Return

UserMgrObjectGetName

RTS_IEC_RESULT
Error code

  • ERR_OK: Object name is returned

  • ERR_PARAMETER: Invalid object handle or pszObject = 0 and piMaxLen = 0

  • ERR_BUFFERSIZE: The buffer was too small

  • ERR_NO_ACCESS_RIGHTS: No access rights in IEC context

Input

hObject

RTS_IEC_HANDLE

Handle to the object

pszObject

POINTER TO STRING

Pointer to buffer to store the name

piMaxLen

POINTER TO UDINT

Pointer to length of buffer in pszObject. If pszObject is 0, only the length of the object name is returned in piMaxLen