uint32_t EI_API_ADP_setTimeSyncUserDescription | ( | T * | pAdp_p, |
const char * | pUserDescription_p | ||
) |
Set the Description member of UserDescription attribute of the Time Sync object of the adapter (Instance Attribute ID: 23).
Function that sets the Description member of UserDescription attribute of the Time Sync object of the adapter selected by parameter pAdp_p
. UserDescription specifies the user description of the device that contains the clock. The format is:
For example: Sensor-1; Section-7 Cabinet-2 Rack-3 The format is UTF-8 Unicode. The maximum number of symbols is 128.
[in] | pAdp_p | Pointer to the adapter. |
[in] | pUserDescription_p | New User Description as NULL (\0) terminated cstring. |
EI_API_ADP_eERR_OK | Success. |
EI_API_ADP_eERR_GENERAL | General error. |
EI_API_ADP_eERR_TIMESYNC_WRONG_FORMAT | Format error. User description must include a semicolon. E.g. Sensor-1; Section-7 Cabinet-2 Rack-3 |