EVT_WDF_CHILD_LIST_IDENTIFICATION_DESCRIPTION_COPY回调函数 (wdfchildlist.h)

项目
08/08/2023

[仅适用于 KMDF]

驱动程序的 EvtChildListIdentificationDescriptionCopy 事件回调函数将子标识说明从一个指定位置复制到另一个指定位置。

语法

EVT_WDF_CHILD_LIST_IDENTIFICATION_DESCRIPTION_COPY EvtWdfChildListIdentificationDescriptionCopy;

void EvtWdfChildListIdentificationDescriptionCopy(
  [in]  WDFCHILDLIST ChildList,
  [in]  PWDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER SourceIdentificationDescription,
  [out] PWDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER DestinationIdentificationDescription
)
{...}

参数

[in] ChildList

框架子列表对象的句柄。

[in] SourceIdentificationDescription

指向 WDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER 结构的指针，该结构标识子标识说明的源位置。

[out] DestinationIdentificationDescription

指向 WDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER 结构的指针，该结构标识子标识说明的目标位置。

返回值

无

备注

如果总线驱动程序正在使用动态枚举，它可以通过调用 WdfFdoInitSetDefaultChildListConfig 或 WdfChildListCreate 来注册 EvtChildListIdentificationDescriptionCopy 回调函数。

当需要使用新信息更新现有说明，或者需要将标识说明的内容传递给驱动程序时，框架会将信息从驱动程序提供的标识说明复制到另一个驱动程序。

EvtChildListIdentificationDescriptionCopy 回调函数必须将源说明的内容复制到目标说明。如果框架无法调用 RtlCopyMemory 来复制标识说明，则驱动程序必须提供此回调函数。 (如果说明包含指向其他内存的指针，则框架无法调用 RtlCopyMemory 。)

如果驱动程序未提供 EvtChildListIdentificationDescriptionCopy 回调函数，框架将通过调用 RtlCopyMemory 复制标识说明。

以下步骤描述了一种可能的方案：

遍历子列表的驱动程序调用 WdfChildListRetrieveNextDevice。驱动程序提供 WDF_CHILD_RETRIEVE_INFO 结构，以便它可以接收子设备的标识说明。
框架调用 EvtChildListIdentificationDescriptionCopy 回调函数 (如果存在) 或 RtlCopyMemory 来复制设备的标识说明。复制操作的源是框架的描述的内部副本。目标是驱动程序在其WDF_CHILD_RETRIEVE_INFO结构中分配和标识的内存。

如果说明包含由WDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER结构的 IdentificationDescriptionSize 成员指定的具有预先确定大小的单个结构，则框架可以使用 RtlCopyMemory 复制标识说明。但是，有时说明还必须包含存储在动态分配的内存中的其他信息。在这种情况下，通常会定义说明结构，以便成员指向动态分配的内存，并且驱动程序必须提供 EvtChildListIdentificationDescriptionCopy 回调函数。回调函数必须执行以下操作：

在回调函数的 SourceIdentificationDescription 和 DestinationIdentificationDescription 结构中，找到指向动态分配的内存的指针。
使用指针将动态分配的内存从源复制到目标。
将回调函数的 SourceIdentificationDescription 结构中的其他结构成员复制到回调函数的 DestinationIdentificationDescription 结构。

驱动程序的 EvtChildListIdentificationDescriptionCopy 回调函数可以调用的唯一框架子列表对象方法是 WdfChildListGetDevice。

框架在调用 EvtChildListIdentificationDescriptionCopy 回调函数之前获取内部子列表对象锁。回调函数必须仅执行与复制操作相关的操作，例如调用框架内存对象方法和访问对象上下文空间。它不得调用访问其他驱动程序的方法。

如果驱动程序提供 EvtChildListIdentificationDescriptionCopy 回调函数，则它可能还需要 EvtChildListIdentificationDescriptionDuplicate、 EvtChildListIdentificationDescriptionCompare 和 EvtChildListIdentificationDescriptionCleanup 回调函数。

有关动态枚举的详细信息，请参阅枚举总线上的设备。