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.

Return the number of bytes copied from the message buffer to the application side. Might be 0 if the offset is outside the available length, or less than wBytesToRead if wOffset+bBytesToRead exceeds available length.

Parameters

[in]	hMsg	Handle to the Transfer Message.
[in]	wFromOffset	Message buffer offset
[in]	wBytesToRead	Number of bytes to read from the message's buffer
[out]	pwBytesRead	Pointer to the number of bytes successfully read
[out]	ppBuffer	Pointer to a byte array pointer filled with data buffer address.

Returns

Standard CHAILink Client return code. See CLC_ErrorCode enumeration.

Remarks

If succeeded, the data pointed to by *ppBuffer are valid until the next CHAILink call.