PropVariantClear

9/8/2008

Essa função libera todos os elementos que podem ser liberados em uma estrutura determinado PROPVARIANT. Para elementos complexos com ponteiros elemento conhecidos, o subjacente elementos são liberados antes para liberar o elemento que contém.

Syntax

WINOLEAPI PropVariantClear(
  PROPVARIANT* pvar
);

Parameters

• pvar
  [no] Ponteiro para uma inicializada PROPVARIANT estrutura para que quaisquer elementos deallocatable devem ser liberado. Em retorno, todos os zeros são gravados a PROPVARIANT estrutura.

Valores Return

A seguinte tabela mostra os valores de retorno para esta função.

Valor	Descrição
S_OK	Os tipos VT são reconhecidos e todos os itens que podem ser liberados tiverem sido liberados.
STG_E_INVALID_PARAMETER	A variante tem um tipo VT desconhecido.

Remarks

Em qualquer nível de engano, NULL os ponteiros são ignorados. De exemplo, o pvar parâmetro aponta para um PROPVARIANT estrutura do tipo VT_CF. O pclipdata membro das PROPVARIANT estrutura aponta para um CLIPDATA estrutura. O pclipData ponteiro in a CLIPDATA estrutura é NULL. Neste exemplo, o pclipData ponteiro será ignorado. No entanto, o CLIPDATA estrutura apontado pelo pclipdata membro das PROPVARIANT estrutura é liberada.

Em retorno, essa função grava zeros para especificado PROPVARIANT estrutura, portanto, a VT-tipo é VT_EMPTY.

Passando NULL como o pvar parâmetro produz um código de retorno de S_OK.

Observação

Não use esta função para inicializar PROPVARIANT estruturas.Em vez disso, inicializar essas estruturas usando a macro PropVariantInit (definida em propidl.h).

Requirements

Header	oaidl.h
Library	oleaut32.lib
Windows Embedded CE	Windows CE 2.0 and later
Windows Mobile	Windows Mobile Version 5.0 and later

See Also

Reference

Automation Functions
FreePropVariantArray
PROPVARIANT