CLC_ErrorCode Output_SendModifierMessage	(	CPHOBJECT const	hOutput,
		CPMODIFIERMSG const *const	pMessageData,
		CPBOOLEAN const	fFlush
	)

Send a modifier message. If the device recording is armed and no time stamp specified yet, a system time stamp is automatically added to the message.

Parameters

[in]	hOutput	Output handle
[in]	pMessageData	modifier message data (see CPMODIFIERMSG structure in CLCm_Defines.h)
[in]	fFlush	If 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.