PropVariantClear-Funktion (combaseapi.h)

  • Artikel

Die PropVariantClear-Funktion gibt alle Elemente frei, die in einer bestimmten PROPVARIANT-Struktur freigegeben werden können. Bei komplexen Elementen mit bekannten Elementzeigern werden die zugrunde liegenden Elemente vor dem Freigeben des enthaltenden Elements freigegeben.

Syntax

HRESULT PropVariantClear(
  [in] PROPVARIANT *pvar
);

Parameter

[in] pvar

Ein Zeiger auf eine initialisierte PROPVARIANT-Struktur , für die alle delegierbaren Elemente freigegeben werden sollen. Bei der Rückgabe werden alle Nullen in die PROPVARIANT-Struktur geschrieben.

Rückgabewert

Diese Funktion gibt HRESULT zurück.

Hinweise

Auf jeder Dereferenzierungsebene werden NULL-Zeiger ignoriert. Der pvar-Parameter verweist beispielsweise auf eine PROPVARIANT-Struktur vom Typ VT_CF. Das pclipdata-Element der PROPVARIANT-Struktur zeigt auf eine CLIPDATA-Struktur . Der pClipData-Zeiger in der CLIPDATA-Struktur ist NULL. In diesem Beispiel wird der pClipData-Zeiger ignoriert. Die CLIPDATA-Struktur , auf die vom pclipdata-Element der PROPVARIANT-Struktur verwiesen wird, wird jedoch freigegeben.

Bei der Rückgabe schreibt diese Funktion Nullen in die angegebene PROPVARIANT-Struktur , sodass der VT-Typ VT_EMPTY ist.

Das Übergeben von NULL als pvar-Parameter erzeugt einen Rückgabecode von S_OK.

Hinweis Verwenden Sie diese Funktion nicht, um PROPVARIANT-Strukturen zu initialisieren. Initialisieren Sie diese Strukturen stattdessen mithilfe des Makros PropVariantInit (definiert in Propidl.h).
 

Anforderungen

   
Unterstützte Mindestversion (Client) Windows 2000 Professional [Desktop-Apps | UWP-Apps]
Unterstützte Mindestversion (Server) Windows 2000 Server [Desktop-Apps | UWP-Apps]
Zielplattform Windows
Kopfzeile combaseapi.h
Bibliothek Ole32.lib
DLL Ole32.dll

Weitere Informationen

FreePropVariantArray