CHAILink SDK  Version 1.3
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
CLC_ErrorCode Output_Send ( CPHOBJECT const  hOutput,
CPHOOKEDOBJECT const  hMessage,
CPBOOLEAN const  fFlush 
)

Send a message with flush control, allowing multipart messages. If the device recording is armed and no time stamp specified yet, a system time stamp is automatically added to the message.

Parameters
[in]hOutputOutput handle
[in]hMessageMessage handle. This message object can be released as soon this method returns.
[in]fFlushIf TRUE, the message is immediately prepared and sent, including prospective multipart messages added before. Setting fFlush at TRUE is the normal way to send a single message, or to specify the last and send the whole of a multipart message. If FALSE, the message is added to the multipart buffer, except if the buffer is full. In this case, the multipart message is sent, and a new one is created to store the new message.
Returns
Standard CHAILink Client return code. See CLC_ErrorCode enumeration.
Remarks
If some destination is not yet validated, the method returns ERR_SentToNotYetValidatedDestination. The message delivery is not guaranteed for those destinations.
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.