CHAILink SDK  Version 1.3
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
CLC_ErrorCode RemoteDevice_Learn ( CPHOOKEDOBJECT const  hRemoteDevice,
CPBOOLEAN const  fActivate,
CPUINT16 const  wControllerID 
)

Set the remote device in learning mode.

Parameters
[in]hRemoteDeviceHandle to the remote device.
[in]fActivateTRUE to activate the learn mode, FALSE to stop it.
[in]wControllerIDThe controller ID to be assigned by learning.
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.