Edit

SERCX2_PIO_TRANSMIT_CONFIG structure (sercx.h)

  • Article

The SERCX2_PIO_TRANSMIT_CONFIG structure contains information that version 2 of the serial framework extension (SerCx2) uses to configure a new PIO-transmit object.

Syntax

typedef struct _SERCX2_PIO_TRANSMIT_CONFIG {
  ULONG                                             Size;
  PFN_SERCX2_PIO_TRANSMIT_INITIALIZE_TRANSACTION    EvtSerCx2PioTransmitInitializeTransaction;
  PFN_SERCX2_PIO_TRANSMIT_CLEANUP_TRANSACTION       EvtSerCx2PioTransmitCleanupTransaction;
  PFN_SERCX2_PIO_TRANSMIT_WRITE_BUFFER              EvtSerCx2PioTransmitWriteBuffer;
  PFN_SERCX2_PIO_TRANSMIT_ENABLE_READY_NOTIFICATION EvtSerCx2PioTransmitEnableReadyNotification;
  PFN_SERCX2_PIO_TRANSMIT_CANCEL_READY_NOTIFICATION EvtSerCx2PioTransmitCancelReadyNotification;
  PFN_SERCX2_PIO_TRANSMIT_DRAIN_FIFO                EvtSerCx2PioTransmitDrainFifo;
  PFN_SERCX2_PIO_TRANSMIT_CANCEL_DRAIN_FIFO         EvtSerCx2PioTransmitCancelDrainFifo;
  PFN_SERCX2_PIO_TRANSMIT_PURGE_FIFO                EvtSerCx2PioTransmitPurgeFifo;
} SERCX2_PIO_TRANSMIT_CONFIG, *PSERCX2_PIO_TRANSMIT_CONFIG;

Members

Size

The size, in bytes, of this structure. The SerCx2PioTransmitCreate method uses this member to determine which version of the structure the caller is using. The size of this structure might change in future versions of the Sercx.h header file.

EvtSerCx2PioTransmitInitializeTransaction

A pointer to the driver-implemented EvtSerCx2PioTransmitInitializeTransaction event callback function. This member must point to a valid function.

EvtSerCx2PioTransmitCleanupTransaction

A pointer to the driver-implemented EvtSerCx2PioTransmitCleanupTransaction event callback function. This member must point to a valid function.

EvtSerCx2PioTransmitWriteBuffer

A pointer to the driver-implemented EvtSerCx2PioTransmitWriteBuffer event callback function. This member must point to a valid function.

EvtSerCx2PioTransmitEnableReadyNotification

A pointer to the driver-implemented EvtSerCx2PioTransmitEnableReadyNotification event callback function. This member must point to a valid function.

EvtSerCx2PioTransmitCancelReadyNotification

A pointer to the driver-implemented EvtSerCx2PioTransmitCancelReadyNotification event callback function. This member must point to a valid function.

EvtSerCx2PioTransmitDrainFifo

A pointer to the driver-implemented EvtSerCx2PioTransmitDrainFifo event callback function. This member is optional and can be set to NULL to indicate that the driver does not implement the function. However, a driver that implements this function must also implement EvtSerCx2PioTransmitCancelDrainFifo and EvtSerCx2PioTransmitPurgeFifo functions.

EvtSerCx2PioTransmitCancelDrainFifo

A pointer to the driver-implemented EvtSerCx2PioTransmitCancelDrainFifo event callback function. This member is optional and can be set to NULL to indicate that the driver does not implement the function. However, a driver that implements this function must also implement EvtSerCx2PioTransmitDrainFifo and EvtSerCx2PioTransmitPurgeFifo functions.

EvtSerCx2PioTransmitPurgeFifo

A pointer to the driver-implemented EvtSerCx2PioTransmitPurgeFifo event callback function. This member is optional and can be set to NULL to indicate that the driver does not implement the function. However, a driver that implements this function must also implement EvtSerCx2PioTransmitDrainFifo and EvtSerCx2PioTransmitCancelDrainFifo functions.

Remarks

The SerCx2PioTransmitCreate method accepts a pointer to a SERCX2_PIO_TRANSMIT_CONFIG structure as an input parameter. Before calling SerCx2PioTransmitCreate, call the SERCX2_PIO_TRANSMIT_CONFIG_INIT function to initialize this structure.

Requirements

Requirement Value
Minimum supported client Supported starting with Windows 8.1.
Header sercx.h

See also

EvtSerCx2PioTransmitCancelDrainFifo

EvtSerCx2PioTransmitCancelReadyNotification

EvtSerCx2PioTransmitCleanupTransaction

EvtSerCx2PioTransmitDrainFifo

EvtSerCx2PioTransmitEnableReadyNotification

EvtSerCx2PioTransmitInitializeTransaction

EvtSerCx2PioTransmitPurgeFifo

EvtSerCx2PioTransmitWriteBuffer

SERCX2_PIO_TRANSMIT_CONFIG_INIT

SerCx2PioTransmitCreate