PropVariantClear, fonction (combaseapi.h)

La fonction PropVariantClear libère tous les éléments qui peuvent être libérés dans une structure PROPVARIANT donnée. Pour les éléments complexes avec des pointeurs d’éléments connus, les éléments sous-jacents sont libérés avant de libérer l’élément conteneur.

Syntaxe

HRESULT PropVariantClear(
  [in] PROPVARIANT *pvar
);

Paramètres

[in] pvar

Pointeur vers une structure PROPVARIANT initialisée pour laquelle tous les éléments désallocatables doivent être libérés. Au retour, tous les zéros sont écrits dans la structure PROPVARIANT .

Valeur retournée

Cette fonction retourne HRESULT.

Remarques

À n’importe quel niveau d’indirection, les pointeurs NULL sont ignorés. Par exemple, le paramètre pvar pointe vers une structure PROPVARIANT de type VT_CF. Le membre pclipdata de la structure PROPVARIANT pointe vers une structure CLIPDATA . Le pointeur pClipData dans la structure CLIPDATA est NULL. Dans cet exemple, le pointeur pClipData est ignoré. Toutefois, la structure CLIPDATA pointée par le membre pclipdata de la structure PROPVARIANT est libérée.

Au retour, cette fonction écrit des zéros dans la structure PROPVARIANT spécifiée, de sorte que le type VT est VT_EMPTY.

Le passage de NULL en tant que paramètre pvar produit un code de retour de S_OK.

Configuration requise

Voir aussi

FreePropVariantArray