CHAILink SDK  Version 1.3
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Data Transfer Message Functions

List of all Data Transfer Message functions. More...

Number handling

Set the message's number

Parameters
[in]hMsgHandle to the Transfer Message.
[in]wNumberMessage's number.
Returns
Standard CHAILink Client return code. See CLC_ErrorCode enumeration.
CLC_ErrorCode DataTransferMessage_SetNumber (CPHOOKEDOBJECT const hMsg, CPUINT16 const wNumber)
 
CLC_ErrorCode DataTransferMessage_GetNumber (CPHOOKEDOBJECT const hMsg, CPUINT16 *const pwNumber)
 Get the message's number. More...
 

Set the message buffer

CLC_ErrorCode DataTransferMessage_GetSendBufferLength (CPHOOKEDOBJECT const hMsg, CPUINT16 *const pwSendBufferLength)
 Get the maximum number of bytes the message can carry. More...
 
CLC_ErrorCode DataTransferMessage_SetSendBuffer (CPHOOKEDOBJECT const hMsg, CPUINT16 const wToOffset, CPUINT16 const wBytesToCopy, CPBYTE const *const pSrcBuffer)
 Fill the message buffer with data coming from the application. More...
 

Get the message buffer

CLC_ErrorCode DataTransferMessage_GetReceiveBufferLength (CPHOOKEDOBJECT const hMsg, CPUINT16 *const pwReceiveBufferLength)
 Get the number of bytes available. More...
 
CLC_ErrorCode DataTransferMessage_GetReceiveBuffer (CPHOOKEDOBJECT const hMsg, CPUINT16 const wFromOffset, CPUINT16 const wBytesToRead, CPUINT16 *const pwBytesRead, CPBYTE const **const ppBuffer)
 Get the message buffer content. More...
 

Detailed Description

List of all Data Transfer Message functions.