CHAILink SDK  Version 1.3
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
CLC_ErrorCode CHAI_RemoteDevice_FindFirst_Async ( FindDeviceOptions const  options,
CPDEVICEID const *const  pParentDevID,
DeviceCapabilities const  includeDeviceCapabilities,
DeviceCapabilities const  excludeDeviceCapabilities,
InOutCapabilities const  includeInputCapabilities,
InOutCapabilities const  excludeInputCapabilities,
InOutCapabilities const  includeOutputCapabilities,
InOutCapabilities const  excludeOutputCapabilities,
CPUINT16 const  wBrandID,
CPUINT16 const  wModelID,
CPUINT32 const  dwDuplicateNumberFrom,
CPUINT32 const  dwDuplicateNumberTo,
CPUINT16 const  wModuleIDFrom,
CPUINT16 const  wModuleIDTo,
CPUINT32 const  dwClientContextData,
CPHASYNC *const  phAsync 
)

Find the first device according the specified filtering arguments.

Parameters
[in]optionsFind options flags (FDO_XXX) combination. See FindDeviceOptions enumeration.
[in]pParentDevIDPointer to the Parent ID (not used if FDO_NoHierarchy is set)
[in]includeDeviceCapabilitiesIncluded device capabilities flags. Use DC_Any to keep all devices.
[in]excludeDeviceCapabilitiesExcluded device capabilities flags. Use DC_None to keep all devices.
[in]includeInputCapabilitiesIncluded input capabilities flags. Use IOC_Any to keep all devices.
[in]excludeInputCapabilitiesExcluded input capabilities flags. Use IOC_None to keep all devices.
[in]includeOutputCapabilitiesIncluded output capabilities flags. Use IOC_Any to keep all devices.
[in]excludeOutputCapabilitiesExcluded output capabilities flags. Use IOC_None to keep all devices.
[in]wBrandIDBrand ID filter. Use 0xFFFF as wildcard.
[in]wModelIDModel ID filter. Use 0xFFFF as wildcard.
[in]dwDuplicateNumberFromFirst duplicate number. Use 0xFFFFFFFF as wildcard.
[in]dwDuplicateNumberToLast duplicate number. Use 0xFFFFFFFF as wildcard.
[in]wModuleIDFromFirst module ID. Use 0xFFFF as wildcard.
[in]wModuleIDToLast module ID. Use 0xFFFF as wildcard.
[in]dwClientContextDataData passed back to the ARH_CHAI_REMOTEDEVICE_FIND 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.