Функция PSGetPropertyDescriptionByName (propsys.h)
Возвращает экземпляр интерфейса описания свойства для указанного имени свойства.
Синтаксис
PSSTDAPI PSGetPropertyDescriptionByName(
[in] LPCWSTR pszCanonicalName,
[in] REFIID riid,
[out] void **ppv
);
Параметры
[in] pszCanonicalName
Тип: LPCWSTR
Указатель на строку Юникода, завершающуюся null, которая идентифицирует свойство .
[in] riid
Тип: REFIID
Ссылка на идентификатор интерфейса запрошенного свойства.
[out] ppv
Тип: void**
При возврате этой функции содержит указатель интерфейса, запрошенный в riid. Обычно это IPropertyDescription, IPropertyDescriptionAliasInfo или IPropertyDescriptionSearchInfo.
Возвращаемое значение
Тип: PSSTDAPI
Возвращает одно из следующих значений.
| Код возврата | Описание |
|---|---|
|
Интерфейс получен. |
|
Параметр pszCanonicalName имеет значение NULL. |
|
Каноническое имя не существует в кэше подсистемы схемы. |
Комментарии
Рекомендуется использовать макрос IID_PPV_ARGS, определенный в objbase.h, для упаковки параметров riid и ppv . Этот макрос предоставляет правильный КОД на основе интерфейса, на который указывает значение в ppv, устраняя возможность ошибки кода.
Рекомендуется, чтобы pszCanonicalName указывал на каноническое имя свойства, например L"System.Keywords". Каноническое имя учитывает регистр.
В дополнение к новым каноническим именам вызывающие объекты могут передавать устаревшее имя для свойства. В следующей таблице приведен полный список поддерживаемых устаревших имен и канонических имен, которым они соответствуют.
| Имя свойства | Сопоставляется со свойством |
|---|---|
| Access | System.DateAccessed |
| Album | System.Music.AlbumTitle |
| Распределить | System.FileAllocationSize |
| Диафрагмы | System.Photo.Aperture |
| Художник | System.Music.Artist |
| Attrib | System.FileAttributes |
| Атрибуты | System.FileAttributes |
| AttributesDescription | System.FileAttributesDisplay |
| Формат звука | System.Audio.Format |
| Размер образца звука | System.Audio.SampleSize |
| BitDepth | System.Image.BitDepth |
| Bitrate | System.Audio.EncodingBitrate |
| CameraModel | System.Photo.CameraModel |
| Capacity | System.Capacity |
| Каналы | System.Audio.ChannelCount |
| ColorSpace | System.Image.ColorSpace |
| Company | System.Company |
| Сжатие | System.Video.Compression |
| Сжатие | System.Video.Compression |
| Авторские права | System.Copyright |
| Авторские права | System.Copyright |
| Авторские права | System.Image.Copyright |
| Создать | System.DateCreated |
| CSCStatus | System.OfflineStatus |
| Скорость передачи данных | System.Video.EncodingBitrate |
| DateDeleted | System.Recycle.DateDeleted |
| DeletedFrom | System.Recycle.DeletedFrom |
| Измерения | System.Image.Dimensions |
| Directory | System.ItemFolderNameDisplay |
| Расстояние | System.Photo.SubjectDistance |
| DocAppName | System.ApplicationName |
| DocAuthor | System.Author |
| DocByteCount | System.Document.ByteCount |
| DocCategory | System.Category |
| DocCharCount | System.Document.CharacterCount |
| DocComments | System.Comment |
| DocCompany | System.Company |
| DocCreatedTm | System.Document.DateCreated |
| DocEditTime | System.Document.TotalEditingTime |
| DocHiddenCount | System.Document.HiddenSlideCount |
| DocKeywords | System.Keywords |
| DocLastAuthor | System.Document.LastAuthor |
| DocLastPrinted | System.Document.DatePrinted |
| DocLastSavedTm | System.Document.DateSaved |
| DocLineCount | System.Document.LineCount |
| DocManager | System.Document.Manager |
| DocNoteCount | System.Document.NoteCount |
| DocPageCount | System.Document.PageCount |
| DocParaCount | System.Document.ParagraphCount |
| DocPresentationTarget | System.Document.PresentationFormat |
| DocRevNumber | System.Document.RevisionNumber |
| DocSlideCount | System.Document.SlideCount |
| DocSubject | System.Subject |
| DocTemplate | System.Document.Template |
| DocTitle | System.Title |
| DocWordCount | System.Document.WordCount |
| Описание DRM | System.DRM.Description |
| Duration | System.Media.Duration |
| EquipMake | System.Photo.CameraManufacturer |
| ExposureBias | System.Photo.ExposureBias |
| ExposureProg | System.Photo.ExposureProgram |
| ExposureTime | System.Photo.ExposureTime |
| FaxCallerID | System.Fax.CallerID |
| FaxCSID | System.Fax.CSID |
| FaxRecipientName | System.Fax.RecipientName |
| FaxRecipientNumber | System.Fax.RecipientNumber |
| FaxRouting | System.Fax.Routing |
| FaxSenderName | System.Fax.SenderName |
| FaxTime | System.Fax.Time |
| FaxTSID | System.Fax.TSID |
| FileDescription | System.FileDescription |
| FileSystem | System.Volume.FileSystem |
| FileType | System.Image.FileType |
| FileVersion | System.FileVersion |
| Мигание | System.Photo.Flash |
| FlashВычайная | System.Photo.Flash |
| FNumber | System.Photo.FNumber |
| FocalLength | System.Photo.FocalLength |
| Частота кадров | System.Video.FrameRate |
| FrameCount | System.Media.FrameCount |
| FreeSpace | System.FreeSpace |
| Genre | System.Music.Genre |
| ImageX | System.Image.HorizontalSize |
| ImageY | System.Image.VerticalSize |
| ISOSpeed | System.Photo.ISOSpeed |
| LightSource | System.Photo.LightSource |
| LinksUpToDate | System.Document.LinksDirty |
| LinkTarget | System.Link.TargetParsingPath |
| Lyrics | System.Music.Lyrics |
| Manager | System.Document.Manager |
| MeteringMode | System.Photo.MeteringMode |
| MMClipCount | System.Document.MultimediaClipCount |
| Имя | System.ItemNameDisplay |
| Владелец | System.FileOwner |
| Число воспроизведения | System.DRM.PlayCount |
| Срок действия воспроизведения истекает | System.DRM.DatePlayExpires |
| Запуски воспроизведения | System.DRM.DatePlayStarts |
| PresentationTarget | System.Document.PresentationFormat |
| ProductName | System.Software.ProductName |
| ProductVersion | System.Software.ProductVersion |
| Project | System.Media.Project |
| Защищенный | System.DRM.IsProtected |
| Ранг | System.Search.Rank |
| Рейтинг | System.Rating |
| ResolutionX | System.Image.HorizontalResolution |
| Разрешение | System.Image.VerticalResolution |
| Частота выборки | System.Audio.SampleRate |
| Масштабирование | System.Document.Scale |
| ShutterSpeed | System.Photo.ShutterSpeed |
| Размер | System.Size |
| Программное обеспечение | System.SoftwareUsed |
| Состояние | System.Media.Status |
| Состояние | System.Status |
| Имя потока | System.Video.StreamName |
| SyncCopyIn | System.Sync.CopyIn |
| Track | System.Music.TrackNumber |
| Тип | System.ItemTypeText |
| Размер выборки видео | System.Video.SampleSize |
| WhenTaken | System.Photo.DateTaken |
| Write | System.DateModified |
| Год | System.Media.Year |
Примеры
В следующем примере, который будет включен в состав более крупной программы, показано, как использовать PSGetPropertyDescriptionByName для получения описания свойства ratings.
IPropertyDescription *pPropDesc;
HRESULT hr = PSGetPropertyDescriptionByName(L"System.Rating", IID_PPV_ARGS(&pPropDesc))
if (SUCCEEDED(hr))
{
// pPropDesc is now valid.
pPropDesc->Release();
}
Требования
| Минимальная версия клиента | Windows XP с пакетом обновления 2 (SP2), Windows Vista [только классические приложения] |
| Минимальная версия сервера | Windows Server 2003 с пакетом обновления 1 (SP1) [только классические приложения] |
| Целевая платформа | Windows |
| Header | propsys.h |
| Библиотека | Propsys.lib |
| DLL | Propsys.dll (версия 5.0 или более поздняя) |
| Распространяемые компоненты | Windows Desktop Search (WDS) 3.0 |