Функция WdfCmResourceListInsertDescriptor (wdfresource.h)

Статья
08/08/2023

[Относится только к KMDF]

Метод WdfCmResourceListInsertDescriptor вставляет дескриптор ресурса в указанный список ресурсов.

Синтаксис

NTSTATUS WdfCmResourceListInsertDescriptor(
  [in] WDFCMRESLIST                    List,
  [in] PCM_PARTIAL_RESOURCE_DESCRIPTOR Descriptor,
  [in] ULONG                           Index
);

Параметры

[in] List

Дескриптор объекта списка ресурсов платформы, который представляет список аппаратных ресурсов для устройства.

[in] Descriptor

Указатель на структуру CM_PARTIAL_RESOURCE_DESCRIPTOR , описывающую аппаратный ресурс.

[in] Index

Отсчитываемое от нуля значение, используемое в качестве индекса в логической конфигурации, указанной list . Чтобы добавить дескриптор ресурса в конец списка ресурсов, укажите WDF_INSERT_AT_END или возвращаемое значение из WdfCmResourceListGetCount.

Возвращаемое значение

WdfCmResourceListInsertDescriptor возвращает STATUS_SUCCESS, если операция выполнена успешно. В противном случае этот метод может возвращать одно из следующих значений:

Код возврата	Описание
STATUS_INVALID_PARAMETER	Указан недопустимый параметр.
STATUS_ACCESS_DENIED	Драйверу не разрешено добавлять дескрипторы в логическую конфигурацию, указанную параметром List . Например, драйверу не удалось изменить логическую конфигурацию, полученную функцией обратного вызова EvtDevicePrepareHardware или EvtDeviceReleaseHardware .
STATUS_INSUFFICIENT_RESOURCES	Платформе не удалось выделить место для хранения дескриптора, на который указывает параметр дескриптора .
STATUS_ARRAY_BOUNDS_EXCEEDED	Значение, указанное параметром Index , было слишком большим.

Системная ошибка проверка возникает, если драйвер предоставляет недопустимый дескриптор объекта.

Метод WdfCmResourceListInsertDescriptor вставляет дескриптор ресурса, указанный дескриптором , в список ресурсов, указанный list, перед дескриптором ресурса, который определяет значение индекса .

Чтобы добавить дескриптор ресурса в конец списка ресурсов, укажите WDF_INSERT_AT_END или возвращаемое значение из WdfCmResourceListGetCount в качестве значения индекса . Кроме того, используйте метод WdfCmResourceListAppendDescriptor .

Платформа копирует содержимое структуры CM_PARTIAL_RESOURCE_DESCRIPTOR во внутреннее хранилище, поэтому подпрограмма драйвера, вызывающая WdfCmResourceListInsertDescriptor , может выделить структуру локально. После вызова WdfCmResourceListInsertDescriptor драйвер может повторно использовать структуру CM_PARTIAL_RESOURCE_DESCRIPTOR.

Дополнительные сведения о списках ресурсов см. в разделе Аппаратные ресурсы для драйверов Framework-Based.

Примеры

В следующем примере кода дескриптор ресурса добавляется в конец списка ресурсов, который получает функция обратного вызова EvtDeviceResourcesQuery .

NTSTATUS
PdoEvtDeviceResourcesQuery(
    IN WDFDEVICE  Device,
    IN WDFCMRESLIST  Resources
    )
{
    CM_PARTIAL_RESOURCE_DESCRIPTOR newDescriptor;
...
    newDescriptor.Type = CmResourceTypePort;
    newDescriptor.ShareDisposition = CmResourceShareDeviceExclusive;
    newDescriptor.Flags = CM_RESOURCE_PORT_IO|CM_RESOURCE_PORT_16_BIT_DECODE;
    newDescriptor.u.Port.Length = 1;
    newDescriptor.u.Port.Start = 0;

    status = WdfCmResourceListInsertDescriptor(
                                               Resources,
                                               &newDescriptor,
                                               WDF_INSERT_AT_END
                                               );
...

}

Требования

Требование	Значение
Целевая платформа	Универсальное
Минимальная версия KMDF	1,0
Верхняя часть	wdfresource.h (включая Wdf.h)
Библиотека	Wdf01000.sys (см. раздел Управление версиями библиотеки Платформы).
IRQL	<=DISPATCH_LEVEL
Правила соответствия DDI	DriverCreate(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf)