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

Get a device property.

Query the remote device about one of its properties, depending on propertyID argument.

Parameters
[in]hRemoteDeviceHandle to the remote device.
[in]ecThe exploration command. see ExplorationCommands
[in]propertyIDRelevant when ec in (EC_FindNext, EC_FindPrev, EC_Get). requested property related to the exploration command. (see DeviceProperties for standard proertiesenumeration in CLC_Enums.h)
[in]dwClientContextDataData passed back to the ARH_REMOTEDEVICE_GETPROPERTYSTRING or ARH_REMOTEDEVICE_GETPROPERTYNUMERIC 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.