uint32_t EI_API_ADP_setTimeSyncProductDescription | ( | T * | pAdp_p, |
const char * | pProductDesc_p | ||
) |
Set the Description member of the ProductDescription attribute of the Time Sync object of the adapter (Instance Attribute ID: 21).
Function that sets the Description member of ProductDescription attribute of the Time Sync object of the adapter selected by parameter pAdp_p
. ProductDescription specifies the product description of the device that contains the clock. The format is:
For example: ACME Manufacturing;C2901;123456 The format is UTF-8 Unicode. The maximum number of symbols is 64.
pProductDesc_p
exceeds 64 characters an error EI_API_ADP_eERR_LENGTH is returned. The format must be like the format described above. Otherwise it is returned EI_API_ADP_eERR_TIMESYNC_WRONG_FORMAT.[in] | pAdp_p | Pointer to the adapter. |
[in] | pProductDesc_p | New product name as NULL (\0) terminated cstring. |
EI_API_ADP_eERR_OK | Success. |
EI_API_ADP_eERR_GENERAL | General error. |
EI_API_ADP_eERR_LENGTH | Illegal parameter length. |
EI_API_ADP_eERR_TIMESYNC_WRONG_FORMAT | Format not accepted. E.g. format "ACME Manufacturing;C2901;123456" |