CLC_Fct_RemoteDevice.h File Reference

Go to the source code of this file.

Functions
Device identity management
CLC_ErrorCode	RemoteDevice_GetInfo (CPHOOKEDOBJECT const hRemoteDevice, CPREMOTEDEVICEINFO *const pInfo)
	Get Remote Device informations. More...
CLC_ErrorCode	RemoteDevice_GetStatus (CPHOOKEDOBJECT const hRemoteDevice, CPBOOLEAN *const pfIsValid)
	Get Remote Device Object status. More...
CLC_ErrorCode	RemoteDevice_GenericChange (CPHOOKEDOBJECT const hRemoteDevice, CPCHAR8 const *const utf8CustomName, CPUINT32 const dwDuplicateNumber, DuplicateModes const duplicateMode, CPUINT32 const dwGroups)
	Apply generic changes. More...
Asynchronous device information
CLC_ErrorCode	RemoteDevice_GetName_Async (CPHOOKEDOBJECT const hRemoteDevice, DeviceNameFormats const format, CPUINT32 const dwClientContextData, CPHASYNC *const phAsync)
	Get the device name. More...
CLC_ErrorCode	RemoteDevice_GetProperty_Async (CPHOOKEDOBJECT const hRemoteDevice, ExplorationCommands const ec, DeviceProperties const propertyID, CPUINT32 const dwClientContextData, CPHASYNC *const phAsync)
	Get a device property. More...
Normal destination handling
CLC_ErrorCode	RemoteDevice_ClearAllDestinations (CPHOOKEDOBJECT const hRemoteDevice, CPBOOLEAN const fRecursive)
	Clear all destinations on all Outputs. More...
CLC_ErrorCode	RemoteDevice_ClearDestinations (CPHOOKEDOBJECT const hRemoteDevice, CPUINT16 const wOutputID)
	Clear all destinations for the specified Output. More...
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. More...
CLC_ErrorCode	RemoteDevice_GetDetailedDestination_Async (CPHOOKEDOBJECT const hRemoteDevice, CPUINT16 const wOutputID_or_ControllerID, CPUINT16 const wDestinationIndex, CPUINT32 const dwClientContextData, CPHASYNC *const phAsync)
	Get a destination with more details (path, machine name...) This method can be used to enumerate the current destinations related to the specified Output. More...
CLC_ErrorCode	RemoteDevice_AddDestination (CPHOOKEDOBJECT const hRemoteDevice, CPUINT16 const wOutputID, CPENDPOINT const *const pDestination)
	Add a destination to an Output. More...
CLC_ErrorCode	RemoteDevice_ChangeDestination (CPHOOKEDOBJECT const hRemoteDevice, CPUINT16 const wOutputID, CPENDPOINT const *const pPrevDestination, CPENDPOINT const *const pNewDestination)
	Change a destination on an Output. More...
CLC_ErrorCode	RemoteDevice_RemoveDestination (CPHOOKEDOBJECT const hRemoteDevice, CPUINT16 const wOutputID, CPENDPOINT const *const pDestination)
	Remove a destination from an Output. More...
CLC_ErrorCode	RemoteDevice_GetDestinationCount_Async (CPHOOKEDOBJECT const hRemoteDevice, CPUINT16 const wOutputID_or_ControllerID, CPUINT32 const dwClientContextData, CPHASYNC *const phAsync)
	Get the number of destination. More...
CLC_ErrorCode	RemoteDevice_GetConnectedDevices_Async (CPHOOKEDOBJECT const hRemoteDevice, CPBOOLEAN const fIncludingSubDevices, CPUINT32 const dwClientContextData, CPHASYNC *const phAsync)
	Get the list of connected devices. More...
Device exploration
CLC_ErrorCode	RemoteDevice_GetInputInformation_Async (CPHOOKEDOBJECT const hRemoteDevice, ExplorationCommands const ec, CPUINT16 const wInputID, CPUINT32 const dwClientContextData, CPHASYNC *const phAsync)
	Get input information. More...
CLC_ErrorCode	RemoteDevice_GetOutputInformation_Async (CPHOOKEDOBJECT const hRemoteDevice, ExplorationCommands const ec, CPUINT16 const wOutputID, CPUINT32 const dwClientContextData, CPHASYNC *const phAsync)
	Get output information. More...
CLC_ErrorCode	RemoteDevice_GetControllerInfo_Async (CPHOOKEDOBJECT const hRemoteDevice, ExplorationCommands const ec, CPUINT16 const wControllerID, CPUINT32 const dwClientContextData, CPHASYNC *const phAsync)
	Get controller description. More...
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. More...
CLC_ErrorCode	RemoteDevice_GetModifierDataTypeInfo_Async (CPHOOKEDOBJECT const hRemoteDevice, ExplorationCommands const ec, CPPARAMETERID const *const pParamID, DataTypes const dataType, CPUINT32 const dwClientContextData, CPHASYNC *const phAsync)
	Get Modifier parameter value range for a specific data type. More...
CLC_ErrorCode	RemoteDevice_GetSelectorParameterValueText_Async (CPHOOKEDOBJECT const hRemoteDevice, CPHOOKEDOBJECT const hSelectorItemListID, CPUINT16 const wItemIndex, CPBOOLEAN const fRequestMultipleValues, CPUINT32 const dwClientContextData, CPHASYNC *const phAsync)
	Get Selector parameter item description. More...
CLC_ErrorCode	RemoteDevice_GetIndexListItem_Async (CPHOOKEDOBJECT const hRemoteDevice, CPHOOKEDOBJECT const hIndexListID, CPUINT16 const wIndex, CPBOOLEAN const fRequestMultipleValues, CPUINT32 const dwClientContextData, CPHASYNC *const phAsync)
	Get Index display text. More...
Controller handling
CLC_ErrorCode	RemoteDevice_AssignController (CPHOOKEDOBJECT const hRemoteDevice, CPUINT16 const wControllerID, CPCONTROLLERASSIGNMENT const *const pControllerAssignment)
	Assign a controller to a message. More...
CLC_ErrorCode	RemoteDevice_ResetController (CPHOOKEDOBJECT const hRemoteDevice, CPUINT16 const wControllerID)
	Reset default controller assignment. More...
CLC_ErrorCode	RemoteDevice_ResetAllControllers (CPHOOKEDOBJECT const hRemoteDevice, CPBOOLEAN const fRecursive)
	Reset all controllers. More...
Snapshot
CLC_ErrorCode	RemoteDevice_CollectSnapshotData_Async (CPHOOKEDOBJECT const hRemoteDevice, SnapshotTypes const snapshotType, CPUINT32 const dwOffset, CPUINT32 const dwContextData, CPUINT16 const wMaxBlockSize, CPUINT32 const dwClientContextData, CPHASYNC *const phAsync)
	Collect Snapshot data. More...
CLC_ErrorCode	RemoteDevice_RestoreSnapshotData_Async (CPHOOKEDOBJECT const hRemoteDevice, SnapshotTypes const snapshotType, CPUINT32 const dwOffset, CPUINT32 const dwContextData, CPUINT16 const wBlockSize, CPBOOLEAN const fLastBlock, CPBYTE const *const pBlockData, CPUINT32 const dwClientContextData, CPHASYNC *const phAsync)
	Restore a Snapshot data block to the remote device. More...
Learning
CLC_ErrorCode	RemoteDevice_Learn (CPHOOKEDOBJECT const hRemoteDevice, CPBOOLEAN const fActivate, CPUINT16 const wControllerID)
	Set the remote device in learning mode. More...
Smart Connect
CLC_ErrorCode	RemoteDevice_SmartConnectStart_Async (CPHOOKEDOBJECT const hRemoteDevice, CPUINT16 const wArraySize, CPDEVICEID const *const arSourceDeviceIDs, CPUINT32 const dwClientContextData, CPHASYNC *const phAsync)
	Initiate a SmartConnect session. Call this method from the RemoteDevice related to the target. The source device IDs array contains a list of controller devices to be assigned during this session. More...