IFWXSocket::Recv method

Applies to: desktop apps only

The Receive method receives a buffer asynchronously. It performs an overlapped receive (or receive from operation, depending on the socket type).

Syntax

HRESULT Recv(
  [in]  IFWXIOBuffer *pIOBuffer,
  [in]  IFWXIOCompletion *pIFWXIOCompletion,
  [in]  UserContextType UserData
);

Parameters

• pIOBuffer [in]
  Pointer to the buffer that receives the data.

  This parameter may be set to NULL, so that the Microsoft Firewall service will create the buffer. In this case, the same buffer object can be passed between data filters, and buffer copy will be avoided. The IFWXIOCompletion::CompleteAsyncIO completion method receives a buffer object as one of its arguments.

• pIFWXIOCompletion [in]
  Pointer to the IFWXIOCompletion interface that receives the completion notification. This parameter is required. it cannot be NULL.

• UserData [in]
  An opaque value to pass to the IFWXIOCompletion::CompleteAsyncIO notification method. This parameter provides a context to the notification.

Return value

This method returns S_OK if the call is successful; otherwise, it returns an error code.

Requirements

See also

IFWXSocket

Build date: 7/12/2010