Função PSGetPropertyDescriptionByName (propsys.h)
Obtém uma instância de uma interface de descrição de propriedade para um nome de propriedade especificado.
Sintaxe
PSSTDAPI PSGetPropertyDescriptionByName(
[in] LPCWSTR pszCanonicalName,
[in] REFIID riid,
[out] void **ppv
);
Parâmetros
[in] pszCanonicalName
Tipo: LPCWSTR
Um ponteiro para uma cadeia de caracteres Unicode terminada em nulo que identifica a propriedade .
[in] riid
Tipo: REFIID
Referência à ID da interface da propriedade solicitada.
[out] ppv
Tipo: void**
Quando essa função retorna, contém o ponteiro de interface solicitado em riid. Normalmente, isso é IPropertyDescription, IPropertyDescriptionAliasInfo ou IPropertyDescriptionSearchInfo.
Valor retornado
Tipo: PSSTDAPI
Retorna um dos valores a seguir.
| Código de retorno | Descrição |
|---|---|
|
A interface foi obtida. |
|
O parâmetro pszCanonicalName é NULL. |
|
O nome canônico não existe no cache do subsistema de esquema. |
Comentários
É recomendável que você use a macro IID_PPV_ARGS, definida em objbase.h, para empacotar os parâmetros riid e ppv . Essa macro fornece o IID correto com base na interface apontada pelo valor em ppv, eliminando a possibilidade de um erro de codificação.
Recomendamos que pszCanonicalName aponte para o nome canônico de uma propriedade, por exemplo, L"System.Keywords". O nome canônico diferencia maiúsculas de minúsculas.
Além dos novos nomes canônicos, os chamadores podem passar um nome herdado para uma propriedade. A tabela a seguir contém a lista completa de nomes herdados com suporte e os nomes canônicos aos qual eles correspondem.
| Nome da propriedade | Mapeia para propriedade |
|---|---|
| Access | System.DateAccessed |
| Álbum | System.Music.AlbumTitle |
| AllocSize | System.FileAllocationSize |
| Abertura | System.Photo.Aperture |
| Artista | System.Music.Artist |
| Attrib | System.FileAttributes |
| Atributos | System.FileAttributes |
| AttributesDescription | System.FileAttributesDisplay |
| Formato de áudio | System.Audio.Format |
| Tamanho da amostra de áudio | System.Audio.SampleSize |
| BitDepth | System.Image.BitDepth |
| Bitrate | System.Audio.EncodingBitrate |
| CameraModel | System.Photo.CameraModel |
| Capacity | System.Capacity |
| Canais | System.Audio.ChannelCount |
| Colorspace | System.Image.ColorSpace |
| Empresa | System.Company |
| Compactação | System.Video.Compression |
| Compactação | System.Video.Compression |
| Direitos autorais | System.Copyright |
| Direitos autorais | System.Copyright |
| Direitos autorais | System.Image.Copyright |
| Criar | System.DateCreated |
| CSCStatus | System.OfflineStatus |
| Taxa de dados | System.Video.EncodingBitrate |
| DateDeleted | System.Recycle.DateDeleted |
| DeletedFrom | System.Recycle.DeletedFrom |
| Dimensões | System.Image.Dimensions |
| Diretório | System.ItemFolderNameDisplay |
| Distância | 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 |
| Descrição do DRM | System.DRM.Description |
| Duração | 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 |
| Piscando | System.Photo.Flash |
| FlashEnergy | System.Photo.FlashEnergy |
| FNumber | System.Photo.FNumber |
| FocalLength | System.Photo.FocalLength |
| Taxa de Quadros | System.Video.FrameRate |
| FrameCount | System.Media.FrameCount |
| FreeSpace | System.FreeSpace |
| Gênero | 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 |
| Gerente | System.Document.Manager |
| MeteringMode | System.Photo.MeteringMode |
| MMClipCount | System.Document.MultimediaClipCount |
| Nome | System.ItemNameDisplay |
| Proprietário | System.FileOwner |
| Contagem de Reprodução | System.DRM.PlayCount |
| A reprodução expira | System.DRM.DatePlayExpires |
| Inícios de Reprodução | System.DRM.DatePlayStarts |
| PresentationTarget | System.Document.PresentationFormat |
| ProductName | System.Software.ProductName |
| ProductVersion | System.Software.ProductVersion |
| Project | System.Media.Project |
| Protegido | System.DRM.IsProtected |
| Rank | System.Search.Rank |
| Classificação | System.Rating |
| ResolutionX | System.Image.HorizontalResolution |
| Resolução | System.Image.VerticalResolution |
| Taxa de amostragem | System.Audio.SampleRate |
| Escala | System.Document.Scale |
| Shutterspeed | System.Photo.ShutterSpeed |
| Tamanho | System.Size |
| Software | System.SoftwareUsed |
| Status | System.Media.Status |
| Status | System.Status |
| Nome do Fluxo | System.Video.StreamName |
| SyncCopyIn | System.Sync.CopyIn |
| Rastrear | System.Music.TrackNumber |
| Type | System.ItemTypeText |
| Tamanho do exemplo de vídeo | System.Video.SampleSize |
| WhenTaken | System.Photo.DateTaken |
| Gravar | System.DateModified |
| Year | System.Media.Year |
Exemplos
O exemplo a seguir, a ser incluído como parte de um programa maior, demonstra como usar PSGetPropertyDescriptionByName para recuperar a descrição da propriedade ratings.
IPropertyDescription *pPropDesc;
HRESULT hr = PSGetPropertyDescriptionByName(L"System.Rating", IID_PPV_ARGS(&pPropDesc))
if (SUCCEEDED(hr))
{
// pPropDesc is now valid.
pPropDesc->Release();
}
Requisitos
| Cliente mínimo com suporte | Windows XP com SP2, Windows Vista [somente aplicativos da área de trabalho] |
| Servidor mínimo com suporte | Windows Server 2003 com SP1 [somente aplicativos da área de trabalho] |
| Plataforma de Destino | Windows |
| Cabeçalho | propsys.h |
| Biblioteca | Propsys.lib |
| DLL | Propsys.dll (versão 5.0 ou posterior) |
| Redistribuível | Pesquisa da Área de Trabalho do Windows (WDS) 3.0 |