PSGetPropertyDescriptionByName-Funktion (propsys.h)

  • Artikel

Ruft eine instance einer Eigenschaftenbeschreibungsschnittstelle für einen angegebenen Eigenschaftennamen ab.

Syntax

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

Parameter

[in] pszCanonicalName

Typ: LPCWSTR

Ein Zeiger auf eine Unicode-Zeichenfolge mit Null-Beendigung, die die Eigenschaft identifiziert.

[in] riid

Typ: REFIID

Verweis auf die Schnittstellen-ID der angeforderten Eigenschaft.

[out] ppv

Typ: void**

Wenn diese Funktion zurückgibt, enthält den in riid angeforderten Schnittstellenzeiger. Dies ist in der Regel IPropertyDescription, IPropertyDescriptionAliasInfo oder IPropertyDescriptionSearchInfo.

Rückgabewert

Typ: PSSTDAPI

Gibt einen der folgenden Werte zurück.

Rückgabecode BESCHREIBUNG
S_OK
 Die Schnittstelle wurde abgerufen.
E_INVALIDARG
 Der parameter pszCanonicalName ist NULL.
TYPE_E_ELEMENTNOTFOUND
 Der kanonische Name ist im Cache des Schemasubsystems nicht vorhanden.

Hinweise

Es wird empfohlen, das makro IID_PPV_ARGS zu verwenden, das in objbase.h definiert ist, um die Parameter riid und ppv zu packen. Dieses Makro stellt die richtige IID basierend auf der Schnittstelle bereit, auf die der Wert in ppv verweist, wodurch die Möglichkeit eines Codierungsfehlers beseitigt wird.

Es wird empfohlen, pszCanonicalName auf den kanonischen Namen einer Eigenschaft zu verweisen, z. B L"System.Keywords". . Beim kanonischen Namen wird die Groß-/Kleinschreibung beachtet.

Zusätzlich zu den neuen kanonischen Namen können Aufrufer einen Legacynamen für eine Eigenschaft übergeben. Die folgende Tabelle enthält die vollständige Liste der unterstützten Legacynamen und die kanonischen Namen, die ihnen entsprechen.

Eigenschaftenname Zuordnung zur Eigenschaft
Access System.DateAccessed
Album System.Music.AlbumTitle
Zuweisen System.FileAllocationSize
Blende System.Photo.Aperture
Künstler System.Music.Artist
Attrib System.FileAttributes
Attribute System.FileAttributes
AttributeBeschreibung System.FileAttributesDisplay
Audioformat System.Audio.Format
Audiobeispielgröße System.Audio.SampleSize
BitDepth System.Image.BitDepth
Bitrate System.Audio.EncodingBitrate
CameraModel System.Photo.CameraModel
Capacity System.Capacity
Channels System.Audio.ChannelCount
Farbraum System.Image.ColorSpace
Company System.Company
Komprimierung System.Video.Compression
Komprimierung System.Video.Compression
Copyright System.Copyright
Copyright System.Copyright
Copyright System.Image.Copyright
Erstellen System.DateCreated
CSCStatus System.OfflineStatus
Datenrate System.Video.EncodingBitrate
DateDeleted System.Recycle.DateDeleted
DeletedFrom System.Recycle.DeletedFrom
Dimensionen System.Image.Dimensions
Verzeichnis System.ItemFolderNameDisplay
Distance 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-Beschreibung 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
Blinken System.Photo.Flash
FlashEnergy System.Photo.FlashEnergy
FNumber System.Photo.FNumber
FocalLength System.Photo.FocalLength
Frame Rate 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
Lichtquelle 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
Name System.ItemNameDisplay
Besitzer System.FileOwner
Anzahl der Wiedergabe System.DRM.PlayCount
Wiedergabe läuft ab System.DRM.DatePlayExpires
Play Starts System.DRM.DatePlayStarts
PresentationTarget System.Document.PresentationFormat
ProductName System.Software.ProductName
ProductVersion System.Software.ProductVersion
Projekt System.Media.Project
Protected System.DRM.IsProtected
Rang System.Search.Rank
Rating System.Rating
ResolutionX System.Image.HorizontalResolution
AuflösungY System.Image.VerticalResolution
Samplingrate System.Audio.SampleRate
Skalieren System.Document.Scale
Shutterspeed System.Photo.ShutterSpeed
Size System.Size
Software System.SoftwareUsed
Status System.Media.Status
Status System.Status
Streamname System.Video.StreamName
SyncCopyIn System.Sync.CopyIn
Track System.Music.TrackNumber
Typ System.ItemTypeText
Videobeispielgröße System.Video.SampleSize
WhenTaken System.Photo.DateTaken
Schreiben System.DateModified
Year System.Media.Year
 

Beispiele

Im folgenden Beispiel, das als Teil eines größeren Programms eingeschlossen werden soll, wird veranschaulicht, wie Sie PSGetPropertyDescriptionByName verwenden, um die Beschreibung für die Bewertungseigenschaft abzurufen.

IPropertyDescription *pPropDesc;

HRESULT hr = PSGetPropertyDescriptionByName(L"System.Rating", IID_PPV_ARGS(&pPropDesc))

if (SUCCEEDED(hr))
{
    // pPropDesc is now valid.
 
    pPropDesc->Release();
}

Anforderungen

   
Unterstützte Mindestversion (Client) Windows XP mit SP2, Windows Vista [nur Desktop-Apps]
Unterstützte Mindestversion (Server) Windows Server 2003 mit SP1 [nur Desktop-Apps]
Zielplattform Windows
Kopfzeile propsys.h
Bibliothek Propsys.lib
DLL Propsys.dll (Version 5.0 oder höher)
Verteilbare Komponente Windows Desktop Search (WDS) 3.0

Weitere Informationen

IPropertySystem

PSGetPropertyDescription