EVT_SERCX2_PIO_RECEIVE_CANCEL_READY_NOTIFICATION回调函数 (sercx.h)
EvtSerCx2PioReceiveCancelReadyNotification 事件回调函数由串行框架扩展版本 2 (SerCx2) 调用,以取消先前调用 EvtSerCx2PioReceiveEnableReadyNotification 事件回调函数时启用的就绪通知。
语法
EVT_SERCX2_PIO_RECEIVE_CANCEL_READY_NOTIFICATION EvtSercx2PioReceiveCancelReadyNotification;
BOOLEAN EvtSercx2PioReceiveCancelReadyNotification(
[in] SERCX2PIORECEIVE PioReceive
)
{...}
参数
[in] PioReceive
PIO 接收对象的 SERCX2PIORECEIVE 句柄。 串行控制器驱动程序以前调用 SerCx2PioReceiveCreate 方法来创建此对象。
返回值
EvtSerCx2PioReceiveCancelReadyNotification 函数返回 TRUE(如果已准备好的通知已成功禁用,并且串行控制器驱动程序可以保证此通知不会导致调用 SerCx2PioReceiveReady 方法)。 如果驱动程序已调用 SerCx2PioReceiveReady或即将调用此方法,则函数将返回 FALSE。
言论
串行控制器驱动程序必须实现此函数。 驱动程序在创建 PIO 接收对象的 SerCx2PioReceiveCreate 调用中注册函数。
如果在启用就绪通知时关联的读取请求超时或取消,则 SerCx2 调用 EvtSerCx2PioReceiveCancelReadyNotification 函数来取消挂起的通知。 如果此调用返回 FALSE,则 SerCx2 要求串行控制器驱动程序调用 SerCx2PioReceiveReady;只有在此调用之后,SerCx2 才会调用 EvtSerCx2PioReceiveCleanupTransaction 事件回调函数(如果已实现)并完成请求。
若要取消就绪通知,EvtSerCx2PioReceiveCancelReadyNotification 函数通常会禁用串行控制器中的中断,指示可从接收 FIFO 读取更多数据。 先前对 EvtSerCx2PioReceiveEnableReadyNotification 函数的调用启用了此中断。
有关详细信息,请参阅 SerCx2 PIO-Receive 事务。
例子
若要定义 EvtSerCx2PioReceiveCancelReadyNotification 回调函数,必须先提供一个函数声明来标识要定义的回调函数的类型。 Windows 为驱动程序提供一组回调函数类型。 使用回调函数类型声明函数有助于 驱动程序代码分析、静态驱动程序验证程序(SDV)和其他验证工具查找错误,这是为 Windows 操作系统编写驱动程序的要求。
例如,若要定义名为 的 MyPioReceiveCancelReadyNotification
回调函数,请使用 EVT_SERCX2_PIO_RECEIVE_CANCEL_READY_NOTIFICATION 函数类型,如以下代码示例所示:
EVT_SERCX2_PIO_RECEIVE_CANCEL_READY_NOTIFICATION MyPioReceiveCancelReadyNotification;
然后,按如下所示实现回调函数:
_Use_decl_annotations_
BOOLEAN
MyPioReceiveCancelReadyNotification(
SERCX2PIORECEIVE PioReceive
)
{...}
EVT_SERCX2_PIO_RECEIVE_CANCEL_READY_NOTIFICATION 函数类型在 Sercx.h 头文件中定义。 若要在运行代码分析工具时更准确地识别错误,请务必将 Use_decl_annotations 注释添加到函数定义。 Use_decl_annotations 批注可确保使用应用于头文件中 EVT_SERCX2_PIO_RECEIVE_CANCEL_READY_NOTIFICATION 函数类型的批注。 有关函数声明要求的详细信息,请参阅 使用 KMDF 驱动程序的函数角色类型声明函数。 有关 Use_decl_annotations的详细信息,请参阅 批注函数行为。
要求
要求 | 价值 |
---|---|
最低支持的客户端 | 从Windows 8.1开始可用。 |
目标平台 | 桌面 |
标头 | sercx.h |
IRQL | 在 IRQL <调用 = DISPATCH_LEVEL。 |