共用方式為

EVT_SERCX2_PURGE_FIFOS回呼函式 （sercx.h）

  • 發行項

EvtSerCx2PurgeFifos 事件回呼函式是由序列架構延伸模組第 2 版 （SerCx2） 呼叫，以清除序列控制器硬體中的 FIFO 緩衝區。

語法

EVT_SERCX2_PURGE_FIFOS EvtSercx2PurgeFifos;

void EvtSercx2PurgeFifos(
  [in] WDFDEVICE Device,
  [in] BOOLEAN PurgeRxFifo,
  [in] BOOLEAN PurgeTxFifo
)
{...}

參數

[in] Device

代表序列控制器之架構裝置物件的WDFDEVICE句柄。 序列控制器驅動程式會在其 EvtDriverDeviceAdd 回呼函式中建立這個物件。 如需詳細資訊，請參閱 SerCx2InitializeDevice。

[in] PurgeRxFifo

是否要清除接收 FIFO。 如果此參數設定為 TRUE，請清除接收 FIFO。 如果 FALSE，請勿清除接收 FIFO。

[in] PurgeTxFifo

是否要清除傳輸 FIFO。 如果此參數設定為 TRUE，請清除傳輸 FIFO。 如果 FALSE，請勿清除傳輸 FIFO。

傳回值

沒有

言論

您的序列控制器驅動程序必須實作此函式。 驅動程式會在呼叫 SerCx2InitializeDevice 方法中註冊函式，以完成序列控制器的架構裝置物件初始化。

SerCx2 會在用戶端 （周邊驅動程式） 傳送需要清除序列控制器硬體中一或兩個 FIFO 緩衝區的 IOCTL_SERIAL_PURGE 控件要求時，呼叫 EvtSerCx2PurgeFifos 函式。 如果 IOCTL_SERIAL_PURGE 控件要求需要取消暫止的讀取或寫入（IRP_MJ_READ 或 IRP_MJ_WRITE）要求，則 SerCx2 會在呼叫 EvtSerCx2PurgeFifos 函式之前取消這些要求。

SerCx2 也會呼叫 EvtSerCx2PurgeFifos 函式，當用戶端開啟序列控制器裝置的邏輯連線並取得此連線的檔案句柄時。 如需詳細資訊，請參閱 Framework File Objects。

例子

若要定義 EvtSerCx2PurgeFifos 回呼函式，您必須先提供函式宣告，以識別您要定義的回呼函式類型。 Windows 提供一組驅動程式的回呼函式類型。 使用回呼函式類型宣告函式有助於 驅動程式的程式代碼分析、靜態驅動程式驗證器 （SDV）和其他驗證工具尋找錯誤，而且是撰寫 Windows 操作系統驅動程式的需求。

例如，若要定義名為 的 MyPurgeFifos 回呼函式，請使用 EVT_SERCX2_PURGE_FIFOS 函式類型，如下列程式代碼範例所示：

EVT_SERCX2_PURGE_FIFOS  MyPurgeFifos;

然後，實作回呼函式，如下所示：

_Use_decl_annotations_
VOID
  MyPurgeFifos(
    WDFDEVICE  Device,
    BOOLEAN PurgeRxFifo,
    BOOLEAN PurgeTxFifo
    )
  {...}

EVT_SERCX2_PURGE_FIFOS 函式類型定義於 Sercx.h 頭檔中。 若要在執行程式代碼分析工具時更準確地識別錯誤，請務必將 Use_decl_annotations 批註新增至函式定義。 Use_decl_annotations 批注可確保會使用套用至頭檔中 EVT_SERCX2_PURGE_FIFOS 函式類型的批注。 如需函式宣告需求的詳細資訊，請參閱 使用 KMDF 驅動程式的函式角色類型來宣告函式。 如需 Use_decl_annotations的詳細資訊，請參閱 批注函式行為。

要求

要求 價值
最低支援的用戶端 從 Windows 8.1 開始提供。
目標平臺 桌面
標頭 sercx.h
IRQL 在 PASSIVE_LEVEL呼叫。

另請參閱

IOCTL_SERIAL_PURGE

SerCx2InitializeDevice