InitPropVariantFromStrRet, fonction (propvarutil.h)

Article
03/04/2024

Initialise une structure PROPVARIANT basée sur une chaîne stockée dans une structure STRRET .

Syntaxe

PSSTDAPI InitPropVariantFromStrRet(
  [in, out] STRRET          *pstrret,
  [in]      PCUITEMID_CHILD pidl,
  [out]     PROPVARIANT     *ppropvar
);

Paramètres

[in, out] pstrret

Type : STRRET*

Pointeur vers une structure STRRET qui contient la chaîne.

[in] pidl

Type : PCUITEMID_CHILD

PIDL de l’élément dont les détails sont récupérés.

[out] ppropvar

Type : PROPVARIANT*

Lorsque cette fonction est retournée, contient la structure PROPVARIANT initialisée.

Valeur retournée

Type : HRESULT

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

Remarques

Crée un propvariant VT_LPWSTR.

Note Cette fonction libère la mémoire utilisée pour le contenu STRRET .

Exemples

L’exemple suivant, à inclure dans le cadre d’un programme plus large, montre comment utiliser InitPropVariantFromStrRet.

// STRRET strret;
// PCUITEMID_CHILD pidl;
// Assume variables strret and pidl are initialized and valid.
PROPVARIANT propvar;

HRESULT hr = InitPropVariantFromStrRet(strret, pidl, &propvar);

if (SUCCEEDED(hr))
{
    // propvar now is valid and has type VT_LPWSTR.
    PropVariantClear(&propvar);
    
    // Any allocated memory associated with strret has been freed.
}

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	propvarutil.h
Bibliothèque	Propsys.lib
DLL	Propsys.dll (version 6.0 ou ultérieure)
Composant redistribuable	Windows Desktop Search (WDS) 3.0