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

Get a destination This method can be used to enumerate the current destinations related to the specified Output.

Remarks
this method can be used to determine the destination of a Controller.
Parameters
[in]hRemoteDeviceHandle to the remote device.
[in]wOutputID_or_ControllerIDThe Output Output or Controller ID.
[in]wDestinationIndexDestination index. To enumerate destinations, start from 0 and loop until the AsyncReturnHandler fails. Note that a Controller manages only one destination.
[in]dwClientContextDataData passed back to the ARH_REMOTEDEVICE_GETDESTINATION 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.