SupervisorOperationRegister (FUN)ΒΆ

FUNCTION SupervisorOperationRegister : RTS_IEC_HANDLE

Register an operation for supervision. The operation will be regtistered disabled! To activate the supervision you have to call a subsequent SupervisorOperationEnable()!

Error code:

  • ERR_OK: Operation was successfully registered

  • ERR_FAILED: Register operation failed

  • ERR_NOTINITIALIZED: The operation memory is not initialized

  • ERR_DUPLICATE: The combination of ui32OperationID and cmpId is already registered

  • ERR_NOMEMORY: There is no more memory left to register the operation

InOut:

Scope

Name

Type

Comment

Return

SupervisorOperationRegister

RTS_IEC_HANDLE

Handle to operation for all other management functions or RTS_INVALID_HANDLE in case of an error

Input

ui32OperationID

DWORD

Unique operation ID

cmpId

DWORD

ComponentID of the component which operation is supervised

pszOperationDescription

REFERENCE TO STRING

Description of the operation, may be empty; the string must be a constant, it is not copied, just the reference is stored

stTimeoutUs

ULINT

Timeout limit in [us] (enables time check, 0 means no timeout check)

pResult

POINTER TO RTS_IEC_RESULT

Pointer to error code