Edit

SERCX2_CUSTOM_RECEIVE_TRANSACTION_CONFIG structure (sercx.h)

  • Article

The SERCX2_CUSTOM_RECEIVE_TRANSACTION_CONFIG structure contains information that version 2 of the serial framework extension (SerCx2) uses to configure a new custom-receive-transaction object.

Syntax

typedef struct _SERCX2_CUSTOM_RECEIVE_TRANSACTION_CONFIG {
  ULONG                                                              Size;
  PFN_SERCX2_CUSTOM_RECEIVE_TRANSACTION_INITIALIZE                   EvtSerCx2CustomReceiveTransactionInitialize;
  PFN_SERCX2_CUSTOM_RECEIVE_TRANSACTION_START                        EvtSerCx2CustomReceiveTransactionStart;
  PFN_SERCX2_CUSTOM_RECEIVE_TRANSACTION_CLEANUP                      EvtSerCx2CustomReceiveTransactionCleanup;
  PFN_SERCX2_CUSTOM_RECEIVE_TRANSACTION_ENABLE_NEW_DATA_NOTIFICATION EvtSerCx2CustomReceiveTransactionEnableNewDataNotification;
  PFN_SERCX2_CUSTOM_RECEIVE_TRANSACTION_QUERY_PROGRESS               EvtSerCx2CustomReceiveTransactionQueryProgress;
} SERCX2_CUSTOM_RECEIVE_TRANSACTION_CONFIG, *PSERCX2_CUSTOM_RECEIVE_TRANSACTION_CONFIG;

Members

Size

The size, in bytes, of this structure. The SerCx2CustomReceiveTransactionCreate 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.

EvtSerCx2CustomReceiveTransactionInitialize

A pointer to the driver-implemented EvtSerCx2CustomReceiveTransactionInitialize event callback function. This member is optional and can be set to NULL to indicate that the driver does not implement the function.

EvtSerCx2CustomReceiveTransactionStart

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

EvtSerCx2CustomReceiveTransactionCleanup

A pointer to the driver-implemented EvtSerCx2CustomReceiveTransactionCleanup event callback function. This member is optional and can be set to NULL to indicate that the driver does not implement the function.

EvtSerCx2CustomReceiveTransactionEnableNewDataNotification

A pointer to the driver-implemented EvtSerCx2CustomReceiveTransactionEnableNewDataNotification event callback function. This member is optional and can be set to NULL to indicate that the driver does not implement the function.

EvtSerCx2CustomReceiveTransactionQueryProgress

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

Remarks

The SerCx2CustomReceiveTransactionCreate method accepts a pointer to a SERCX2_CUSTOM_RECEIVE_TRANSACTION_CONFIG structure as an input parameter. Before calling SerCx2CustomReceiveTransactionInitialize, call the SERCX2_CUSTOM_RECEIVE_TRANSACTION_CONFIG_INIT function to initialize this structure.

Requirements

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

See also

EvtSerCx2CustomReceiveTransactionCleanup

EvtSerCx2CustomReceiveTransactionEnableNewDataNotification

EvtSerCx2CustomReceiveTransactionInitialize

EvtSerCx2CustomReceiveTransactionQueryProgress

EvtSerCx2CustomReceiveTransactionStart

SERCX2_CUSTOM_RECEIVE_TRANSACTION_CONFIG_INIT

SerCx2CustomReceiveTransactionCreate