Функция PSStringFromPropertyKey (propsys.h)
Создает строку, определяющую свойство из ключа этого свойства.
Синтаксис
PSSTDAPI PSStringFromPropertyKey(
[in] REFPROPERTYKEY pkey,
[out] LPWSTR psz,
[in] UINT cch
);
Параметры
[in] pkey
Тип: REFPROPERTYKEY
Ссылка на структуру PROPERTYKEY , идентифицирующая свойство.
[out] psz
Тип: LPWSTR
Указатель на буфер, получающий выходную строку. Буфер должен быть достаточно большим, чтобы содержать PKEYSTR_MAX WCHAR.
[in] cch
Тип: UINT
Длина буфера, на который указывает psz, в WCHARs.
Возвращаемое значение
Тип: HRESULT
Если эта функция выполняется успешно, она возвращает S_OK. В противном случае возвращается код ошибки HRESULT .
Комментарии
Полученный строковый формат — "{propkey.fmtid} propkey.pid". Например, выходной строкой для PKEY_Title является "{F29F85E0-4FF9-1068-AB91-08002B27B3D9} 2".
Примеры
В следующем примере, который будет включен в более крупную программу, показано использование PSPropertyKeyFromString.
WCHAR szKey[PKEYSTR_MAX]
HRESULT hr = PSStringFromPropertyKey(PKEY_Title, szKey, ARRAYSIZE(szKey));
if (SUCCEEDED(hr))
{
// szKey is now valid.
}
Требования
| Требование | Значение |
|---|---|
| Минимальная версия клиента | Windows XP с пакетом обновления 2 (SP2), Windows Vista [только классические приложения] |
| Минимальная версия сервера | Windows Server 2003 с пакетом обновления 1 (SP1) [только классические приложения] |
| Целевая платформа | Windows |
| Header | propsys.h |
| Библиотека | Propsys.lib |
| DLL | Propsys.dll (версия 6.0 или более поздняя) |
| Распространяемые компоненты | Windows Desktop Search (WDS) 3.0 |