функция CM_Get_Device_ID_List_SizeA (cfgmgr32.h)

  • Статья

Функция CM_Get_Device_ID_List_Size извлекает размер буфера, необходимый для хранения списка идентификаторов экземпляров устройств для экземпляров устройств локального компьютера.

Синтаксис

CMAPI CONFIGRET CM_Get_Device_ID_List_SizeA(
  [out]          PULONG pulLen,
  [in, optional] PCSTR  pszFilter,
  [in]           ULONG  ulFlags
);

Параметры

[out] pulLen

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

[in, optional] pszFilter

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

[in] ulFlags

Один из необязательных битовых флагов, предоставляемых вызывающим абонентом, который задает фильтры поиска. Если флаги не указаны, функция предоставляет размер буфера, необходимый для хранения всех идентификаторов экземпляров для всех экземпляров устройства. Список битовых флагов см. в описании ulFlags для CM_Get_Device_ID_List.

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

Если операция выполнена успешно, функция возвращает CR_SUCCESS. В противном случае возвращается один из кодов ошибок с префиксом CR_, определенных в Cfgmgr32.h.

Комментарии

Для определения размера буфера, требуемого для CM_Get_Device_ID_List, необходимо вызвать функцию CM_Get_Device_ID_List_Size.

Значение размера, указанное в расположении, на которое указывает pulLen , гарантированно представляет размер буфера, достаточно большой для хранения всех строк идентификаторов экземпляров устройства и завершения значений NULL. Указанное значение может фактически представлять размер буфера, который больше необходимого, поэтому не предполагайте, что значение представляет истинную длину символьных строк, которые CM_Get_Device_ID_List предоставит.

Сведения об идентификаторах экземпляров устройств см. в разделе Строки идентификации устройств.

Примечание

Заголовок cfgmgr32.h определяет CM_Get_Device_ID_List_Size в качестве псевдонима, который автоматически выбирает версию ansi или Юникод этой функции на основе определения константы препроцессора ЮНИКОД. Использование псевдонима, не зависящий от кодирования, с кодом, который не является нейтральным для кодировки, может привести к несоответствиям, которые приводят к ошибкам компиляции или времени выполнения. Дополнительные сведения см. в разделе Соглашения для прототипов функций.

Требования

Требование Значение
Минимальная версия клиента Доступно в Microsoft Windows 2000 и более поздних версиях Windows.
Целевая платформа Универсальное
Верхняя часть cfgmgr32.h (включая Cfgmgr32.h)
Библиотека Cfgmgr32.lib
DLL CfgMgr32.dll

См. также раздел

CM_Get_Device_ID_List_Size_Ex