TraceMgrPacketStop (FUN) ¶ FUNCTION TraceMgrPacketStop : RTS_IEC_RESULT Stops a trace packet. InOut: Scope Name Type Comment Return TraceMgrPacketStop RTS_IEC_RESULT Returns the runtime system error code (see CmpErrors.library): ERR_PARAMETER if hPacket is not a valid packet handle Input hPacket RTS_IEC_HANDLE The trace packet handle
TraceMgrPacketStore (FUN) ¶ FUNCTION TraceMgrPacketStore : RTS_IEC_RESULT Stores a trace packet to a trace file. Both the trace configuration and the current trace values are stored. InOut: Scope Name Type Comment Return TraceMgrPacketStore RTS_IEC_RESULT Returns the runtime system error code (see CmpErrors.library): ERR_PARAMETER if hPacket is not a valid handle, or if pszFileName is not a valid file path ERR_NOMEMORY if the memory is not sufficient for opening the file ERR_NOT_SUPPORTED if writing to files is not supported by the runtime system ERR_NO_OBJECT if opening the file failed ERR_FAILED if creating or writing to the file failed Input hPacket RTS_IEC_HANDLE The trace packet handle Inout Const pszFileName STRING The file path
TraceMgrRecordAdd (FUN) ¶ FUNCTION TraceMgrRecordAdd : RTS_IEC_HANDLE Adds a new record to a trace packet InOut: Scope Name Type Comment Return TraceMgrRecordAdd RTS_IEC_HANDLE Returns the runtime system error code (see CmpErrors.library): ERR_PARAMETER if hPacket is not a valid packet handle, if the variable name is not set, or if the variable type is not supported ERR_NOMEMORY if there is not enough free memory to create the record Input hPacket RTS_IEC_HANDLE The trace packet handle Inout pConfiguration TraceRecordConfiguration The record configuration (in) pResult RTS_IEC_RESULT The result code (out)
TraceMgrRecordGetConfig (FUN) ¶ FUNCTION TraceMgrRecordGetConfig : RTS_IEC_RESULT Queries the configuration of a trace record. InOut: Scope Name Type Comment Return TraceMgrRecordGetConfig RTS_IEC_RESULT Returns the runtime system error code (see CmpErrors.library): ERR_PARAMETER if hPacket or hRecord is not a valid handle Input hPacket RTS_IEC_HANDLE The trace packet handle hRecord RTS_IEC_HANDLE The trace record handle Inout pConfiguration TraceRecordConfiguration The trace record configuration (out)
TraceMgrRecordGetFirst (FUN) ¶ FUNCTION TraceMgrRecordGetFirst : RTS_IEC_HANDLE Returns the first trace record of a trace packet. This function can be used together with TraceMgrRecordGetNext to iterate through all trace records of a packet. InOut: Scope Name Type Comment Return TraceMgrRecordGetFirst RTS_IEC_HANDLE Returns the runtime system error code (see CmpErrors.library): ERR_PARAMETER if hPacket is not a valid packet handle ERR_NO_OBJECT if the packet has no trace record Input hPacket RTS_IEC_HANDLE The trace packet handle Inout pResult RTS_IEC_RESULT The result code (out)
TraceMgrRecordGetNext (FUN) ¶ FUNCTION TraceMgrRecordGetNext : RTS_IEC_HANDLE Returns the next trace record of a trace packet. This function can be used together with TraceMgrRecordGetFirst to iterate through all trace records of a packet. InOut: Scope Name Type Comment Return TraceMgrRecordGetNext RTS_IEC_HANDLE Returns the runtime system error code (see CmpErrors.library): ERR_PARAMETER if hPacket or hPrevRecord is not a valid handle ERR_NO_OBJECT if the packet has no next trace record Input hPacket RTS_IEC_HANDLE The trace packet handle hPrevRecord RTS_IEC_HANDLE The trace record handle of the current record Inout pResult RTS_IEC_RESULT The result code (out)
TraceMgrRecordRemove (FUN) ¶ FUNCTION TraceMgrRecordRemove : RTS_IEC_RESULT Removes a trace record from a trace packet. InOut: Scope Name Type Comment Return TraceMgrRecordRemove RTS_IEC_RESULT Returns the runtime system error code (see CmpErrors.library): ERR_PARAMETER if the packet handle or the record handle is invalid Input hPacket RTS_IEC_HANDLE The packet handle hRecord RTS_IEC_HANDLE The record handle
TraceMgrRecordUpdate (FUN) ¶ FUNCTION TraceMgrRecordUpdate : RTS_IEC_RESULT Records the current value of the trace variable of a record together with the current time stamp. Note This function is called cyclically by CmpTraceMgr. It should not be called by the application. InOut: Scope Name Type Comment Return TraceMgrRecordUpdate RTS_IEC_RESULT Returns the runtime system error code (see CmpErrors.library): ERR_PARAMETER if hPacket or hPrevRecord is not a valid handle ERR_NOTINITIALIZED if the packet is not currently recording (not started, trigger reached, …) ERR_PENDING if no value is recorded for this cycle due to TracePacketConfiguration.ulEveryNCycles ERR_FAILED if reading the value of the trace variable failed Input hPacket RTS_IEC_HANDLE The trace packet handle hRecord RTS_IEC_HANDLE The trace record handle
UserMgrUserGetNext (FUN) ¶ FUNCTION UserMgrUserGetNext : RTS_IEC_RESULT Iteration interface to get next user. Must be started with UserMgrUserGetFirst() InOut: Scope Name Type Comment Return UserMgrUserGetNext RTS_IEC_RESULT Error code ERR_OK: Next user available ERR_NO_OBJECT: No next user available ERR_PARAMETER: Invalid iterator handle ERR_NO_ACCESS_RIGHTS: User not authorized Input hUser RTS_IEC_HANDLE Handle to authorized user Inout phIterator RTS_IEC_HANDLE Iteration handle to use with next call to UserMgrUserGetNext() pszUsername STRING(59) Buffer to store the name, 59 chars max Output UserProperty DWORD User properties. See category ‘User and group properites’
UserMgrUserGetProperty (FUN) ¶ FUNCTION UserMgrUserGetProperty : DWORD Get properties of a user InOut: Scope Name Type Comment Return UserMgrUserGetProperty DWORD The users properties. See category ‘User and group properites’ Input hUser RTS_IEC_HANDLE Handle to authorized user Inout Const pszUser STRING User name, limited to 59 chars Output Result RTS_IEC_RESULT Error code ERR_OK: Properties could be retrieved ERR_NO_ACCESS_RIGHTS: User not authorized