Skip to content

Latest commit

 

History

History
85 lines (58 loc) · 4.33 KB

nf-sercx-sercx2customreceivetransactionnewdatanotification.md

File metadata and controls

85 lines (58 loc) · 4.33 KB
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.SerCx2CustomReceiveTransactionNewDataNotification
SerCx2CustomReceiveTransactionNewDataNotification function (sercx.h)
The SerCx2CustomReceiveTransactionNewDataNotification method notifies version 2 of the serial framework extension (SerCx2) that data is available to be read from the receive FIFO in the serial controller hardware.
serports\sercx2customreceivetransactionnewdatanotification.htm
serports
04/23/2018
SerCx2CustomReceiveTransactionNewDataNotification function
2/SerCx2CustomReceiveTransactionNewDataNotification, SerCx2CustomReceiveTransactionNewDataNotification, SerCx2CustomReceiveTransactionNewDataNotification method [Serial Ports], serports.sercx2customreceivetransactionnewdatanotification
sercx.h
Universal
Available starting with Windows 8.1.
<= DISPATCH_LEVEL
Windows
SerCx2CustomReceiveTransactionNewDataNotification
sercx/SerCx2CustomReceiveTransactionNewDataNotification
APIRef
kbSyntax
COM
2.0\Sercx.h
SerCx2CustomReceiveTransactionNewDataNotification

SerCx2CustomReceiveTransactionNewDataNotification function

-description

The SerCx2CustomReceiveTransactionNewDataNotification method notifies version 2 of the serial framework extension (SerCx2) that data is available to be read from the receive FIFO in the serial controller hardware.

-parameters

-param CustomReceiveTransaction [in]

A SERCX2CUSTOMRECEIVETRANSACTION handle to a custom-receive object. The serial controller driver previously called the SerCx2CustomReceiveTransactionCreate method to create this object.

-remarks

If the receive FIFO in the serial controller becomes empty before a custom-receive transaction can be completed, SerCx2 calls the EvtSerCx2CustomReceiveTransactionEnableNewDataNotification event callback function, if it is implemented, to enable a new-data notification to occur when new data is available to be read from the receive FIFO.

If new-data notifications are enabled and new data is available to be read, the serial controller driver must call SerCx2CustomReceiveTransactionNewDataNotification to notify SerCx2. This notification occurs when the driver detects that one or more new bytes of received data either are ready to be transferred by the custom data-transfer mechanism or have already been transferred by this mechanism.

The serial controller driver must call SerCx2CustomReceiveTransactionNewDataNotification only in response to a call to the EvtSerCx2CustomReceiveTransactionEnableNewDataNotification function.

If a serial controller driver supports new-data notifications for custom-receive transactions, SerCx uses these notifications to detect interval time-outs during the handling of read (IRP_MJ_READ) requests. For more information about interval time-outs, see SERIAL_TIMEOUTS. For more information about new-data notifications, see SerCx2 Custom-Receive Transactions.

-see-also

EvtSerCx2CustomReceiveTransactionEnableNewDataNotification

IRP_MJ_READ

SERCX2CUSTOMRECEIVETRANSACTION

SERIAL_TIMEOUTS

SerCx2CustomReceiveTransactionCreate