...
On failure, this function returns an error code in the format described in Return codes.
Remarks
If there are no HostIDs of the requested type, the string will be empty. If there is more than one of the requested type, the HostIDs are separated by commas.
When using LMX_HOSTID_ALL, all HostIDs are returned, with the HostID type prefixing the HostID; for example, "ETHERNET=0123456789012345,ETHERNET=54321009876543210,USERNAME=MyUserName1,USERNAME=MyUserNameMyUserName2,HOSTNAME=MyHostName,...,", etc. Otherwise"
For single HostIDs, the HostID is returned without the HostID type prefixing the HostIDwith multiple HostIDs of that type separated by commas; for example:
ETHERNET=0123456789012345,ETHERNET=54321009876543210,...", for HostID type LMX_HOSTID_ETHERNET, the string in the preceding example would appear as "0123456789012345".
To make use of custom HostIDs, you must set a callback function using LMX_SetOption with the flag LMX_OPT_CUSTOM_HOSTID_FUNCTION.