CHAILink SDK  Version 1.3
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
CLC_ErrorCode RemoteDevice_GetName_Async ( CPHOOKEDOBJECT const  hRemoteDevice,
DeviceNameFormats const  format,
CPUINT32 const  dwClientContextData,
CPHASYNC *const  phAsync 
)

Get the device name.

Query the remote device about its name, depending on format argument.

Parameters
[in]hRemoteDeviceHandle to the remote device.
[in]formatRequested name format (see DeviceNameFormats enumeration in CLC_Enums.h)
[in]dwClientContextDataData passed back to the ARH_REMOTEDEVICE_GETNAME callback handler.
[out]phAsyncPointer to the handle of the async operation.
Returns
Standard CHAILink Client return code. See CLC_ErrorCode enumeration.
Warning
This function can only be called in CopperLan context. This means in the pseudo task CPDoProcess(), in notification handlers or in asynchronous return handlers and not in SystemDoProcess() for instance.