CLC_ErrorCode Pipe_SendModifierMessage	(	CPHOBJECT const	hPipe,
		CPMODIFIERMSG const *const	pMessageData,
		CPBOOLEAN const	fFlush
	)

Send a modifier message. For performance, this function does not wait for a response.

Parameters

[in]	hPipe	Pipe 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.

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.