CHAILink SDK  Version 1.3
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
CLC_ErrorCode RemoteDevice_GetParameterInfo_Async ( CPHOOKEDOBJECT const  hRemoteDevice,
ExplorationCommands const  ec,
CPSECTIONID const *const  pSectionID,
CPUINT16 const  wFilterInputID,
CPPARAMETERID const *const  pParamID,
CPUINT32 const  dwClientContextData,
CPHASYNC *const  phAsync 
)

Get parameter description.

Parameters
[in]hRemoteDeviceHandle to the remote device.
[in]ecThe exploration command. see ExplorationCommands
[in]pSectionIDRelevant when ec in (EC_FindFirst, EC_FindNext, EC_FindPrev, EC_FindLast). Section ID from where to enumerate parameters. Wildcards can be used (CPNS::SectionID::AnySectionID | CPNS::SectionID::AnyInstanceOf)
[in]wFilterInputIDRelevant when ec in (EC_FindFirst, EC_FindNext, EC_FindPrev, EC_FindLast). Can be used to limit the scan range to a single input in case of sectionID wildcard usage. To avoid filtering, use the wildcard 0xFFFF.
[in]pParamIDRelevant when ec in (EC_FindNext, EC_FindPrev, EC_Get). Parameter ID related to the exploration command
[in]dwClientContextDataData passed back to the ARH_REMOTEDEVICE_GETPARAMINFOMODIFIER, ARH_REMOTEDEVICE_GETPARAMINFOSELECTOR, ARH_REMOTEDEVICE_GETPARAMINFOTEXT or :: ARH_REMOTEDEVICE_GETPARAMINFONODATA 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.