CHAILink SDK  Version 1.3
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
CLC_ErrorCode CHAI_Signal ( CPDEVICEID const *const  pDevID,
CPUINT16 const  wSignalNumber,
CPUINT16 const  wOptionalData0,
CPUINT16 const  wOptionalData1,
CPUINT16 const  wOptionalData2,
CPUINT16 const  wOptionalData3,
CPCHAR8 const *const  utf8OptionalData,
CPENDPOINT const *const  pOptionalEndPoint 
)

Send a signal (broadcast or directed to the specified device)

Parameters
[in]pDevIDPointer to the Target Device ID (NULL for broadcast)
[in]wSignalNumberStandard Signal numbers are available from Signals Enumeration
[in]wOptionalData0Optional value, depending on the signal number
[in]wOptionalData1Optional value, depending on the signal number
[in]wOptionalData2Optional value, depending on the signal number
[in]wOptionalData3Optional value, depending on the signal number
[in]utf8OptionalDataOptional value, depending on the signal number (NULL if not used)
[in]pOptionalEndPointOptional value, depending on the signal number (NULL if not used)
Returns
Standard CHAILink Client return code. See CLC_ErrorCode enumeration.
Remarks
This method send directed signals. So the signal number MUST have SIGB_Directed bit set
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.