PSStringFromPropertyKey-Funktion (propsys.h)

Artikel
03/01/2024

Erstellt eine Zeichenfolge, die eine Eigenschaft aus dem Schlüssel dieser Eigenschaft identifiziert.

Syntax

PSSTDAPI PSStringFromPropertyKey(
  [in]  REFPROPERTYKEY pkey,
  [out] LPWSTR         psz,
  [in]  UINT           cch
);

Parameter

[in] pkey

Typ: REFPROPERTYKEY

Verweis auf eine PROPERTYKEY-Struktur , die eine Eigenschaft identifiziert.

[out] psz

Typ: LPWSTR

Zeiger auf einen Puffer, der die Ausgabezeichenfolge empfängt. Der Puffer sollte groß genug sein, um PKEYSTR_MAX WCHARs zu enthalten.

[in] cch

Typ: UINT

Die Länge des Puffers, auf den psz in WCHARs verweist.

Rückgabewert

Typ: HRESULT

Wenn diese Funktion erfolgreich ist, gibt sie S_OK zurück. Andernfalls wird ein Fehlercode HRESULT zurückgegeben.

Hinweise

Das abgerufene Zeichenfolgenformat ist "{propkey.fmtid} propkey.pid". Die Ausgabezeichenfolge für PKEY_Title ist z. B "{F29F85E0-4FF9-1068-AB91-08002B27B3D9} 2". .

Beispiele

Im folgenden Beispiel, das als Teil eines größeren Programms eingeschlossen werden soll, wird die Verwendung von PSPropertyKeyFromString veranschaulicht.

WCHAR szKey[PKEYSTR_MAX]

HRESULT hr = PSStringFromPropertyKey(PKEY_Title, szKey, ARRAYSIZE(szKey));

if (SUCCEEDED(hr))
{
    // szKey is now valid.
}

Anforderungen

Anforderung	Wert
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 6.0 oder höher)
Verteilbare Komponente	Windows Desktop Search (WDS) 3.0

Weitere Informationen

PSGetNameFromPropertyKey

PSPropertyKeyFromString

Freigeben über