Fonction PSStringFromPropertyKey (propsys.h)

  • Article

Crée une chaîne qui identifie une propriété à partir de la clé de cette propriété.

Syntaxe

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

Paramètres

[in] pkey

Type : REFPROPERTYKEY

Référence à une structure PROPERTYKEY qui identifie une propriété.

[out] psz

Type : LPWSTR

Pointeur vers une mémoire tampon qui reçoit la chaîne de sortie. La mémoire tampon doit être suffisamment grande pour contenir PKEYSTR_MAX WCHAR.

[in] cch

Type : UINT

Longueur de la mémoire tampon pointée vers psz, dans WCHARs.

Valeur retournée

Type : HRESULT

Si cette fonction réussit, elle retourne S_OK. Sinon, elle retourne un code d’erreur HRESULT.

Remarques

Le format de chaîne récupéré est "{propkey.fmtid} propkey.pid". Par exemple, la chaîne de sortie pour PKEY_Title est "{F29F85E0-4FF9-1068-AB91-08002B27B3D9} 2".

Exemples

L’exemple suivant, à inclure dans le cadre d’un programme plus grand, illustre l’utilisation de PSPropertyKeyFromString.

WCHAR szKey[PKEYSTR_MAX]

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

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

Configuration requise

Condition requise Valeur
Client minimal pris en charge Windows XP avec SP2, Windows Vista [applications de bureau uniquement]
Serveur minimal pris en charge Windows Server 2003 avec SP1 [applications de bureau uniquement]
Plateforme cible Windows
En-tête propsys.h
Bibliothèque Propsys.lib
DLL Propsys.dll (version 6.0 ou ultérieure)
Composant redistribuable Windows Desktop Search (WDS) 3.0

Voir aussi

PSGetNameFromPropertyKey

PSPropertyKeyFromString