SERCX2_PIO_RECEIVE_CONFIG_INIT function (sercx.h)

Article
10/21/2021

The SERCX2_PIO_RECEIVE_CONFIG_INIT function initializes a SERCX2_PIO_RECEIVE_CONFIG structure.

Syntax

void SERCX2_PIO_RECEIVE_CONFIG_INIT(
  [out] SERCX2_PIO_RECEIVE_CONFIG                        *PioReceiveConfig,
  [in]  PFN_SERCX2_PIO_RECEIVE_READ_BUFFER               EvtSerCx2PioReceiveReadBuffer,
  [in]  PFN_SERCX2_PIO_RECEIVE_ENABLE_READY_NOTIFICATION EvtSerCx2PioReceiveEnableReadyNotification,
  [in]  PFN_SERCX2_PIO_RECEIVE_CANCEL_READY_NOTIFICATION EvtSerCx2PioReceiveCancelReadyNotification
);

Parameters

[out] PioReceiveConfig

A pointer to the SERCX2_PIO_RECEIVE_CONFIG structure that is to be initialized.

[in] EvtSerCx2PioReceiveReadBuffer

The value to load into the EvtSerCx2PioReceiveReadBuffer member of the SERCX2_PIO_RECEIVE_CONFIG structure. For more information, see the description of this member in SERCX2_PIO_RECEIVE_CONFIG.

[in] EvtSerCx2PioReceiveEnableReadyNotification

The value to load into the EvtSerCx2PioReceiveEnableReadyNotification member of the SERCX2_PIO_RECEIVE_CONFIG structure. For more information, see the description of this member in SERCX2_PIO_RECEIVE_CONFIG.

[in] EvtSerCx2PioReceiveCancelReadyNotification

The value to load into the EvtSerCx2PioReceiveCancelReadyNotification member of the SERCX2_PIO_RECEIVE_CONFIG structure. For more information, see the description of this member in SERCX2_PIO_RECEIVE_CONFIG.

Return value

None

Remarks

Your serial controller driver must use this function to initialize a SERCX2_PIO_RECEIVE_CONFIG structure before passing a pointer to this structure as an input parameter to the SerCx2PioReceiveCreate method.

SERCX2_PIO_RECEIVE_CONFIG_INIT sets the Size member of the structure to sizeof(SERCX2_PIO_RECEIVE_CONFIG), and sets three additional members of the structure to the values supplied as input parameters to the function. The function sets the other members of the structure to zero. The driver can, if necessary, explicitly set these other members to nonzero values after the SERCX2_PIO_RECEIVE_CONFIG_INIT call.

Requirements

Requirement	Value
Minimum supported client	Available starting with Windows 8.1.
Target Platform	Desktop
Header	sercx.h
IRQL	Any level.