Skip to content

Latest commit

 

History

History
136 lines (103 loc) · 4.12 KB

nf-sercx-sercxprogresstransmit.md

File metadata and controls

136 lines (103 loc) · 4.12 KB
Raw
UID title description old-location tech.root ms.date keywords ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames f1_keywords topic_type api_type api_location api_name
NF:sercx.SerCxProgressTransmit
SerCxProgressTransmit function (sercx.h)
The SerCxProgressTransmit method reports the progress of the current write (transmit) operation.
serports\sercxprogresstransmit.htm
serports
04/23/2018
SerCxProgressTransmit function
1/SerCxProgressTransmit, SerCxProgressTransmit, SerCxProgressTransmit method [Serial Ports], serports.sercxprogresstransmit
sercx.h
Universal
Available starting with Windows 8.
<= DISPATCH_LEVEL
Windows
SerCxProgressTransmit
sercx/SerCxProgressTransmit
APIRef
kbSyntax
COM
1.0\Sercx.h
SerCxProgressTransmit

SerCxProgressTransmit function

-description

The SerCxProgressTransmit method reports the progress of the current write (transmit) operation.

-parameters

-param Device [in]

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

-param BytesTransmitted [in]

The number of bytes of data that the caller copied from the transmit buffer that was obtained by the latest call to the SerCxRetrieveTransmitBuffer method.

-param TransmitStatus [in]

The current status of the transmit operation. Set this parameter to one of the following values:

  • SerCxStatusSuccess
  • SerCxStatusCancelled
For more information about these values, see SERCX_STATUS.
Note  The SerCxStatusTimeout value is valid only for receive operations. No interval time-out can be specified for a transmit operation. For more information, see SERIAL_TIMEOUTS.
 

-returns

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

Return code Description
STATUS_INVALID_PARAMETER
 The BytesTransmitted value exceeds the available buffer length; or the TransmitStatus value is not valid.
STATUS_INVALID_DEVICE_REQUEST
 The method was called at the wrong IRQL; or the WDFDEVICE handle is not valid; or the driver has not obtained an output buffer for this transmit operation.
STATUS_CANCELLED
 The transmit operation has already been canceled.

-remarks

The serial controller driver calls this method to report progress on an outstanding write operation. Typically, the serial controller driver calls this method from its DMA completion callback (if the driver uses DMA to read the data) or from its transmit/receive DPC function (if PIO is used).

If the SerCxProgressTransmit call does not complete all outstanding work for the write operation, the caller must call SerCxRetrieveTransmitBuffer again to get a new buffer descriptor and continue to transmit data.

-see-also

SERCX_STATUS

SERIAL_TIMEOUTS

SerCxRetrieveTransmitBuffer