Функция PifMgr_GetProperties (shlobj_core.h)

Статья
03/02/2024

[PifMgr_GetProperties доступно для использования в операционных системах, указанных в разделе Требования. Он может быть изменен или недоступен в последующих версиях.]

Возвращает указанный блок данных из PIF-файла.

Синтаксис

int PifMgr_GetProperties(
  [in, optional]  HANDLE hProps,
  [in, optional]  PCSTR  pszGroup,
  [out, optional] void   *lpProps,
                  int    cbProps,
                  UINT   flOpt
);

Параметры

[in, optional] hProps

Тип: HANDLE

Дескриптор свойств приложения. Для этого параметра следует задать значение, возвращаемое PifMgr_OpenProperties.

[in, optional] pszGroup

Тип: PCSTR

Строка, завершающаяся нулевым значением, которая содержит имя группы свойств. Это может быть одно из следующих имен или любое другое имя, соответствующее допустимому расширению PIF.

"WINDOWS 286 3.0"

"WINDOWS 386 3.0"

"WINDOWS VMM 4.0"

"WINDOWS NT 3.1"

"WINDOWS NT 4.0"

[out, optional] lpProps

Тип: void*

При возврате этой функции содержит указатель на структуру PROPPRG .

cbProps

Тип: int

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

flOpt

Тип: UINT

Задайте для этого параметра значение GETPROPS_NONE.

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

Тип: int

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

Если блок является "именованным", он должен быть именем связанного расширения внутри PIF-файла. Это может быть любое предопределенное имя (например, "WINDOWS 386 3.0") или имя собственного блока. Вы можете создавать собственные именованные блоки данных с помощью PifMgr_SetProperties. Именованные данные также можно рассматривать как необработанные данные, так как они возвращаются вызывающему приложению без преобразования.

Размер именованного блока можно определить, вызвав PifMgr_GetProperties с параметром cbProps, равным 0. Данные не копируются, но возвращается размер запрошенного блока.

Все именованные блоки можно перечислить, задав для pszGroupзначение NULL. lpProps должен быть указателем на 16-байтовый буфер, чтобы содержать запрошенное имя блока, а для cbProps должен быть задан индекс блока от нуля. Возвращаемое значение — это размер блока или нуль, если блок не найден.

Если вы запрашиваете блок неименованных свойств, задав для селектора параметра name значение NULL, а смещение является порядковым номером группы свойств, то возвращается связанная структура. Например, PifMgr_GetProperties(GROUP_TSK) возвращает предопределенную структуру, содержащую все сведения, связанные с задачами, в формате, независимом от PIF-файла. Это ценная служба, так как она освобождает вызывающие приложения от работы с PIF-файлами, содержащими широкий спектр разделов (известных как расширения PIF), когда требуется только один из них.

Требования

Требование	Значение
Минимальная версия клиента	Windows 2000 Professional [только классические приложения]
Минимальная версия сервера	Windows 2000 Server [только классические приложения]
Целевая платформа	Windows
Header	shlobj_core.h
Библиотека	Shell32.lib
DLL	Shell32.dll (версия 5.0 или более поздняя)

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

PifMgr_CloseProperties

PifMgr_OpenProperties

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