Share via

Función PSGetPropertyDescriptionByName (propsys.h)

  • Artículo

Obtiene una instancia de una interfaz de descripción de propiedad para un nombre de propiedad especificado.

Sintaxis

PSSTDAPI PSGetPropertyDescriptionByName(
  [in]  LPCWSTR pszCanonicalName,
  [in]  REFIID  riid,
  [out] void    **ppv
);

Parámetros

[in] pszCanonicalName

Tipo: LPCWSTR

Puntero a una cadena Unicode terminada en null que identifica la propiedad .

[in] riid

Tipo: REFIID

Referencia al identificador de interfaz de la propiedad solicitada.

[out] ppv

Tipo: void**

Cuando se devuelve esta función, contiene el puntero de interfaz solicitado en riid. Suele ser IPropertyDescription, IPropertyDescriptionAliasInfo o IPropertyDescriptionSearchInfo.

Valor devuelto

Tipo: PSSTDAPI

Devuelve uno de los valores siguientes.

Código devuelto Descripción
S_OK
 Se obtuvo la interfaz .
E_INVALIDARG
 El parámetro pszCanonicalName es NULL.
TYPE_E_ELEMENTNOTFOUND
 El nombre canónico no existe en la memoria caché del subsistema de esquema.

Comentarios

Se recomienda usar la macro IID_PPV_ARGS, definida en objbase.h, para empaquetar los parámetros riid y ppv . Esta macro proporciona el IID correcto basado en la interfaz a la que apunta el valor en ppv, lo que elimina la posibilidad de un error de codificación.

Se recomienda que pszCanonicalName apunte al nombre canónico de una propiedad, por ejemplo, L"System.Keywords". El nombre canónico distingue mayúsculas de minúsculas.

Además de los nuevos nombres canónicos, los llamadores pueden pasar un nombre heredado para una propiedad. La tabla siguiente contiene la lista completa de nombres heredados admitidos y los nombres canónicos a los que corresponden.

Nombre de propiedad Se asigna a la propiedad
Access System.DateAccessed
Álbum System.Music.AlbumTitle
AllocSize System.FileAllocationSize
Apertura System.Photo.Aperture
Artista System.Music.Artist
Attrib System.FileAttributes
Atributos System.FileAttributes
AttributesDescription System.FileAttributesDisplay
Formato de audio System.Audio.Format
Tamaño de muestra de audio System.Audio.SampleSize
BitDepth System.Image.BitDepth
Bitrate System.Audio.EncodingBitrate
CameraModel System.Photo.CameraModel
Capacity System.Capacity
Canales System.Audio.ChannelCount
ColorSpace System.Image.ColorSpace
Compañía System.Company
Compresión System.Video.Compression
Compresión System.Video.Compression
Copyright System.Copyright
Copyright System.Copyright
Copyright System.Image.Copyright
Crear System.DateCreated
CSCStatus System.OfflineStatus
Velocidad de datos System.Video.EncodingBitrate
DateDeleted System.Recycle.DateDeleted
DeletedFrom System.Recycle.DeletedFrom
Dimensions System.Image.Dimensions
Directorio System.ItemFolderNameDisplay
Distancia 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
Descripción de 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
Intermitente System.Photo.Flash
FlashEnergy System.Photo.FlashEnergy
FNumber System.Photo.FNumber
Focallength System.Photo.FocalLength
Velocidad de fotogramas 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
Manager System.Document.Manager
MeteringMode System.Photo.MeteringMode
MMClipCount System.Document.MultimediaClipCount
Nombre System.ItemNameDisplay
Propietario System.FileOwner
Recuento de reproducción System.DRM.PlayCount
Expira la reproducción System.DRM.DatePlayExpires
Inicios de la reproducción System.DRM.DatePlayStarts
PresentationTarget System.Document.PresentationFormat
ProductName System.Software.ProductName
ProductVersion System.Software.ProductVersion
Project System.Media.Project
Protegido System.DRM.IsProtected
Rango System.Search.Rank
Rating System.Rating
ResolutionX System.Image.HorizontalResolution
ResoluciónY System.Image.VerticalResolution
Velocidad de muestreo System.Audio.SampleRate
Escala System.Document.Scale
ShutterSpeed System.Photo.ShutterSpeed
Size System.Size
Software System.SoftwareUsed
Estado System.Media.Status
Estado System.Status
Nombre de la secuencia System.Video.StreamName
SyncCopyIn System.Sync.CopyIn
Track System.Music.TrackNumber
Tipo System.ItemTypeText
Tamaño de muestra de vídeo System.Video.SampleSize
WhenTaken System.Photo.DateTaken
Escritura System.DateModified
Year System.Media.Year
 

Ejemplos

En el ejemplo siguiente, para incluirse como parte de un programa mayor, se muestra cómo usar PSGetPropertyDescriptionByName para recuperar la descripción de la propiedad 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 compatible Windows XP con SP2, Windows Vista [solo aplicaciones de escritorio]
Servidor mínimo compatible Windows Server 2003 con SP1 [solo aplicaciones de escritorio]
Plataforma de destino Windows
Encabezado propsys.h
Library Propsys.lib
Archivo DLL Propsys.dll (versión 5.0 o posterior)
Redistribuible Windows Desktop Search (WDS) 3.0

Consulte también

IPropertySystem

PSGetPropertyDescription