EVT_SPB_TARGET_DISCONNECT回调函数 (spbcx.h)

项目
08/07/2023

SPB 控制器驱动程序的 EvtSpbTargetDisconnect 事件回调函数关闭与目标设备的连接，该连接以前是通过调用驱动程序的 EvtSpbTargetConnect 事件回调函数打开的。

语法

EVT_SPB_TARGET_DISCONNECT EvtSpbTargetDisconnect;

void EvtSpbTargetDisconnect(
  [in] WDFDEVICE Controller,
  [in] SPBTARGET Target
)
{...}

参数

[in] Controller

表示 SPB 控制器的框架设备对象的 WDFDEVICE 句柄。

[in] Target

要关闭的目标的 SPBTARGET 句柄。目标是连接到总线的外围设备或端口。 SPB 框架扩展 (SpbCx) 以前将此句柄分配给打开了与目标的连接的 EvtSpbTargetConnect 回调中的目标。

返回值

无

备注

SPB 控制器驱动程序实现此函数是可选的。

SpbCx 管理 SPB 控制器的 I/O 队列。如果 SPB 控制器驱动程序注册 EvtSpbTargetDisconnect 回调函数，则当客户端 (控制器驱动程序的外围驱动程序) 发送关闭 SPBTARGET 句柄的IRP_MJ_CLOSE 请求时，SpbCx 将调用此函数。此句柄表示与客户端在上一个 IRP_MJ_CREATE 请求中打开的总线上目标设备的连接。如果 EvtSpbTargetDisconnect 函数返回错误代码，SpbCx 将无法 IRP_MJ_CLOSE 请求。

在客户端启动的所有 I/O 操作结束后，在客户端启动的所有 I/O 操作结束后，在客户端解锁控制器 (（如果客户端以前锁定控制器) ）之后，将从客户端关闭线程的上下文中同步调用 EvtSpbTargetDisconnect 函数。

如果 SPB 控制器驱动程序已分配 I/O 请求并将其发送到目标设备的 I/O 请求链中下一个较低的驱动程序， 则 EvtSpbTargetDisconnect 函数应在返回之前取消这些请求。

在 EvtSpbTargetDisconnect 回调返回后，可以随时调用客户端驱动程序的 DispatchCleanup 和 CreateProcessNotifyEx 回调例程。当客户端驱动程序的进程退出时，其 CreateProcessNotifyEx 例程将恰好在销毁要退出进程的最后一个线程之前调用。

若要注册 EvtSpbTargetDisconnect 回调函数，请调用 SpbDeviceInitialize 方法。

示例

若要定义 EvtSpbTargetDisconnect 回调函数，必须首先提供一个函数声明来标识要定义的回调函数的类型。 Windows 为驱动程序提供一组回调函数类型。使用回调函数类型声明函数有助于驱动程序代码分析、静态驱动程序验证程序 (SDV) 和其他验证工具查找错误，并且这是编写适用于 Windows 操作系统的驱动程序的要求。

例如，若要定义名为 MyEvtSpbTargetDisconnect的 EvtSpbTargetDisconnect 回调函数，请使用 EVT_SPB_TARGET_DISCONNECT 函数类型，如以下代码示例所示：

EVT_SPB_TARGET_DISCONNECT  MyEvtSpbTargetDisconnect;

然后，按如下所示实现回调函数：

_Use_decl_annotations_
VOID
  MyEvtSpbTargetDisconnect(
    WDFDEVICE Controller,
    SPBTARGET Target
    )
{ ... }

EVT_SPB_TARGET_DISCONNECT函数类型在 Spbcx.h 头文件中定义。若要在运行代码分析工具时更准确地识别错误，请务必将 Use_decl_annotations 注释添加到函数定义。 Use_decl_annotations批注可确保使用应用于头文件中EVT_SPB_TARGET_DISCONNECT函数类型的注释。有关函数声明要求的详细信息，请参阅使用 KMDF 驱动程序的函数角色类型声明函数。有关 Use_decl_annotations的详细信息，请参阅批注函数行为。