SerCxRetrieveReceiveBuffer function (sercx.h)

The SerCxRetrieveReceiveBuffer method obtains an input buffer into which data received from the serial port can be loaded.

Syntax

NTSTATUS SerCxRetrieveReceiveBuffer(
  [in]      WDFDEVICE                Device,
  [in]      ULONG                    Length,
  [in, out] PSERCX_BUFFER_DESCRIPTOR BufferDescriptor
);

Parameters

[in] Device

A WDFDEVICE handle to the framework device object that represents the serial controller.

[in] Length

The requested buffer length, in bytes. If the SerCxRetrieveReceiveBuffer call succeeds, the caller receives an input buffer that contains up to Length bytes of available space. (The available space in the buffer might be less than Length bytes.) SerCxRetrieveReceiveBuffer writes the actual number of bytes of available space to the Length member of the structure pointed to by the BufferDescriptor parameter.

[in, out] BufferDescriptor

A pointer to a caller-allocated SERCX_BUFFER_DESCRIPTOR structure. This structure describes the data buffer to use for the receive operation. The caller previously called the SERCX_BUFFER_DESCRIPTOR_INIT function to initialize this structure. SerCxRetrieveTransmitBuffer writes to the Buffer and Length members of this structure.

Return value

SerCxRetrieveReceiveBuffer returns STATUS_SUCCESS if it is successful. Possible error return values include the following status codes.

Remarks

The serial controller driver calls this method to acquire a buffer to contain input data from the current receive (read) operation.

Requirements

See also

SERCX_BUFFER_DESCRIPTOR

SERCX_BUFFER_DESCRIPTOR_INIT