PropVariantClear 関数 (combaseapi.h)

  • [アーティクル]

PropVariantClear 関数は、特定の PROPVARIANT 構造体で解放できるすべての要素を解放します。 既知の要素ポインターを持つ複合要素の場合、基になる要素は、含まれている要素を解放する前に解放されます。

構文

HRESULT PropVariantClear(
  [in] PROPVARIANT *pvar
);

パラメーター

[in] pvar

割り当て解除可能な要素を解放する初期化された PROPVARIANT 構造体へのポインター。 戻り値では、すべてのゼロが PROPVARIANT 構造体に書き込まれます。

戻り値

この関数は HRESULT を返します。

解説

任意のレベルの間接参照では、 NULL ポインターは無視されます。 たとえば、pvar パラメーターは、VT_CF型の PROPVARIANT 構造体を指します。 PROPVARIANT 構造体の pclipdata メンバーは、CLIPDATA 構造体を指します。 CLIPDATA 構造体の pClipData ポインターは NULL です。 この例では、 pClipData ポインターは無視されます。 ただし、PROPVARIANT 構造体の pclipdata メンバーが指す CLIPDATA 構造体は解放されます。

戻り値の場合、この関数は指定した PROPVARIANT 構造体にゼロを書き込むため、VT 型は VT_EMPTY。

pvar パラメーターとして NULL を渡すと、S_OKの戻りコードが生成されます。

メモPROPVARIANT 構造体を初期化するには、この関数を使用しないでください。 代わりに、 PropVariantInit マクロ (Propidl.h で定義) を使用して、これらの構造体を初期化します。
 

要件

   
サポートされている最小のクライアント Windows 2000 Professional [デスクトップ アプリ |UWP アプリ]
サポートされている最小のサーバー Windows 2000 Server [デスクトップ アプリ |UWP アプリ]
対象プラットフォーム Windows
ヘッダー combaseapi.h
Library Ole32.lib
[DLL] Ole32.dll

関連項目

FreePropVariantArray