CHAILink SDK  Version 1.3
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
CLC_ErrorCode CHAI_CreateDataTransferMessage ( CPUINT16 const  wNumber,
CPHOOKEDOBJECT *const  phMsg 
)

Create a new Data Transfer Message object.

This function creates a new Data Transfer ready to be sent

Parameters
[in]wNumbermessage number, custom value or standard value DTN_*** from DataTransferNumbers enum
[out]phMsgpointer to the Data transfer message handle. CPHHOOKEDOBJECT_NULL if failed
Returns
Standard CHAILink Client return code. See CLC_ErrorCode enumeration.
Remarks
The returned handle must be released using HookedObject_Release function once useless.
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.