Функция WdfRegistryAssignMultiString (wdfregistry.h)

Статья
03/22/2025

[Применимо к KMDF и UMDF]

Метод WdfRegistryAssignMultiString назначает набор строк указанному имени значения в реестре. Строки содержатся в указанной коллекции строковых объектов платформы.

Синтаксис

NTSTATUS WdfRegistryAssignMultiString(
  [in] WDFKEY           Key,
  [in] PCUNICODE_STRING ValueName,
  [in] WDFCOLLECTION    StringsCollection
);

Параметры

[in] Key

Дескриптор объекта реестра, представляющего открытый раздел реестра.

[in] ValueName

Указатель на структуру UNICODE_STRING, содержащую имя значения.

[in] StringsCollection

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

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

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

Код возврата	Описание
STATUS_INVALID_DEVICE_REQUEST	WdfRegistryAssignMultiString не был вызван в IRQL = PASSIVE_LEVEL.
СТАТУС_НЕДЕЙСТВИТЕЛЬНЫЙ_ПАРАМЕТР	Указан недопустимый параметр или коллекция, в которую параметр StringsCollection не содержал строковых объектов.
STATUS_ACCESS_DENIED	Драйвер не открыл раздел реестра с KEY_SET_VALUE доступом.

Этот метод также может возвращать другие значения NTSTATUS.

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

Замечания

Если имя значения, указанное параметром valueName , уже существует, WdfRegistryAssignMultiString обновляет данные значения.

Платформа задает тип данных значения для REG_MULTI_SZ.

Коллекция объектов, которая StringsCollection указывает, должна содержать только строковые объекты платформы.

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

Примеры

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

WDF_OBJECT_ATTRIBUTES attributes;
WDFCOLLECTION col = NULL;
WDFSTRING string1 = NULL, string2 = NULL;
UNICODE_STRING ustring1, ustring2, valueName;
NTSTATUS status;

status = WdfCollectionCreate(
                             WDF_NO_OBJECT_ATTRIBUTES,
                             &col
                             );
if (!NT_SUCCESS(status) {
    return status;
}

RtlInitUnicodeString(
                     &ustring1,
                     L"String1"
                     );
RtlInitUnicodeString(
                     &ustring2,
                     L"String2"
                     );
RtlInitUnicodeString(
                     &valueName,
                     L"ValueName"
                     );

WDF_OBJECT_ATTRIBUTES_INIT(&attributes);
attributes.ParentObject = col;

status = WdfStringCreate(
                         &ustring1,
                         &attributes,
                         &string1
                         );
if (!NT_SUCCESS(status)) {
    goto exit;
}
status = WdfStringCreate(
                         &ustring2,
                         &attributes,
                         &string2
                         );
if (!NT_SUCCESS(status)) {
    goto exit;
}
status = WdfCollectionAdd(
                          col,
                          string1
                          );
if (!NT_SUCCESS(status)) {
    goto exit;
}
string1 = NULL;

status = WdfCollectionAdd(
                          col,
                          string2
                          );
if (!NT_SUCCESS(status)) {
    goto exit;
}
string2 = NULL;

status = WdfRegistryAssignMultiString(
                                      Key,
                                      &valueName,
                                      col
                                      );
if (!NT_SUCCESS(status)) {
    goto exit;
...
exit:
if (col != NULL) {
    WdfObjectDelete(col);    // This will empty the collection
                             // because the string objects are
                             // child objects of the collection object.
}

Требования

Требование	Ценность
целевая платформа	универсальный
минимальная версия KMDF	1.0
минимальная версия UMDF	2.0
Заголовок	wdfregistry.h (include Wdf.h)
Библиотека	Wdf01000.sys (KMDF); WUDFx02000.dll (UMDF)
IRQL	PASSIVE_LEVEL
правил соответствия DDI	DriverCreate(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf)