Функция ResUtilEnumProperties (resapi.h)

Статья
03/01/2024

Перечисляет имена свойств объекта кластера. Тип PRESUTIL_ENUM_PROPERTIES определяет указатель на эту функцию.

Синтаксис

DWORD ResUtilEnumProperties(
  [in]  const PRESUTIL_PROPERTY_ITEM pPropertyTable,
  [out] LPWSTR                       pszOutProperties,
  [in]  DWORD                        cbOutPropertiesSize,
  [out] LPDWORD                      pcbBytesReturned,
  [out] LPDWORD                      pcbRequired
);

Параметры

[in] pPropertyTable

Указатель на массив RESUTIL_PROPERTY_ITEM структур, описывающих свойства для перечисления.

[out] pszOutProperties

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

[in] cbOutPropertiesSize

Размер в байтах выходного буфера, на который указывает pszOutProperties.

[out] pcbBytesReturned

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

[out] pcbRequired

Количество байтов, необходимое, если выходной буфер слишком мал.

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

Если операция выполнена успешно, функция возвращает ERROR_SUCCESS.

Если операция завершается сбоем, функция возвращает код системной ошибки. Ниже приведены возможные коды ошибок.

Код возврата	Описание
ERROR_BAD_ARGUMENTS	Один или несколько входных параметров были недопустимы.
ERROR_NOT_ENOUGH_MEMORY	Произошла ошибка при выделении памяти.
ERROR_MORE_DATA	Размер выходного буфера слишком мал для хранения результирующей данных. Параметр pcbRequired указывает на правильный размер.

Требования

Требование	Значение
Минимальная версия клиента	Ни одна версия не поддерживается
Минимальная версия сервера	Windows Server 2008 Корпоративная, Windows Server 2008 Datacenter
Целевая платформа	Windows
Header	resapi.h
Библиотека	ResUtils.lib
DLL	ResUtils.dll

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

RESUTIL_PROPERTY_ITEM

Поделиться через