Função PropVariantClear (combaseapi.h)

  • Artigo

A função PropVariantClear libera todos os elementos que podem ser liberados em uma determinada estrutura PROPVARIANT . Para elementos complexos com ponteiros de elemento conhecidos, os elementos subjacentes são liberados antes de liberar o elemento que contém.

Sintaxe

HRESULT PropVariantClear(
  [in] PROPVARIANT *pvar
);

Parâmetros

[in] pvar

Um ponteiro para uma estrutura PROPVARIANT inicializada para a qual todos os elementos desalocantes devem ser liberados. No retorno, todos os zeros são gravados na estrutura PROPVARIANT .

Valor retornado

Essa função retorna HRESULT.

Comentários

Em qualquer nível de indireção, os ponteiros NULL são ignorados. Por exemplo, o parâmetro pvar aponta para uma estrutura PROPVARIANT do tipo VT_CF. O membro pclipdata da estrutura PROPVARIANT aponta para uma estrutura CLIPDATA . O ponteiro pClipData na estrutura CLIPDATA é NULL. Neste exemplo, o ponteiro pClipData é ignorado. No entanto, a estrutura CLIPDATA apontada pelo membro pclipdata da estrutura PROPVARIANT é liberada.

No retorno, essa função grava zeros na estrutura PROPVARIANT especificada, portanto, o tipo VT é VT_EMPTY.

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

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

Requisitos

   
Cliente mínimo com suporte Windows 2000 Professional [aplicativos da área de trabalho | Aplicativos UWP]
Servidor mínimo com suporte Windows 2000 Server [aplicativos da área de trabalho | Aplicativos UWP]
Plataforma de Destino Windows
Cabeçalho combaseapi.h
Biblioteca Ole32.lib
DLL Ole32.dll

Confira também

FreePropVariantArray