ILMNetConnection::Recv

#include "netcon2.h"

C Syntax	HRESULT ILMNetConnection_Recv(pCon, pbBuffer, cbBuffer, pcbReceived, nTimeout)
C++ Syntax	HRESULT Recv(pbBuffer, cbBuffer, pcbReceived, nTimeout)

ILMNetConnection * pCon;	/* pointer to an interface */
BYTE* pbBuffer;	/* pointer to a buffer */
DWORD cbBuffer;	/* buffer size */
DWORD* pcbReceived;	/* pointer to a variable */
DWORD nTimeout;	/* timeout value */

Retrieves the incoming data from the other end of the connection.

Parameter	Description
pCon	Pointer to an ILMNetConnection interface.
pbBuffer	Pointer to the buffer to be updated with the received data.
cbBuffer	Value that represents the size, in bytes, of the data to be received.
pcbReceived	Pointer to a variable to be updated with the actual number of bytes received.
nTimeout	The maximum silence time before failing the receive operation. This time is specified in milliseconds.

Returns

S_OK	The function was successful.
<> S_OK	An error occurred. Refer to the Error Codes or the HRESULT error codes in the DirectShow documentation.

Comments

This function can return any non-zero amount of data up to the specified cbBuffer size.

If the connection has been remotely closed and no more data is available, the amount of received data will be set to zero and the function will return the S_OK success code.

Required DLLs and Libraries

LMNetCon
DSKernel

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

Platforms

Win32, x64

See Also

Functions:	ILMNetConnection::Send, ILMNetConnection::Disconnect, ILMNetConnection::IsConnected, ILMNetConnection::GetPeerName, ILMNetConnection::CancelBlockingCall
Topics:	Video Streaming Function Groups, Multimedia Function Group, DVD Function Groups

Example

For examples, refer to How to Create a User-Defined Protocol and How to Network (Client and Server) Using a User-Defined Protocol.