CHAILink SDK  Version 1.3
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
CLC_ErrorCode RemoteDevice_GetControllerInfo_Async ( CPHOOKEDOBJECT const  hRemoteDevice,
ExplorationCommands const  ec,
CPUINT16 const  wControllerID,
CPUINT32 const  dwClientContextData,
CPHASYNC *const  phAsync 
)

Get controller description.

Parameters
[in]hRemoteDeviceHandle to the remote device.
[in]ecThe exploration command. see ExplorationCommands
[in]wControllerIDRelevant when ec in (EC_FindFirst, EC_FindNext, EC_FindPrev, EC_FindLast). Controller ID related to the exploration command
[in]dwClientContextDataData passed back to the ARH_REMOTEDEVICE_GETCONTROLLERINFO 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.