Compartilhar via

Função PropVariantToBooleanVectorAlloc (propvarutil.h)

  • Artigo

Extrai dados de uma estrutura PROPVARIANT em um vetor booliano recém-alocado.

Sintaxe

PSSTDAPI PropVariantToBooleanVectorAlloc(
  [in]  REFPROPVARIANT propvar,
  [out] BOOL           **pprgf,
  [out] ULONG          *pcElem
);

Parâmetros

[in] propvar

Tipo: REFPROPVARIANT

Referência a uma estrutura PROPVARIANT de origem .

[out] pprgf

Tipo: BOOL**

Quando essa função retorna, contém um ponteiro para um vetor de valores boolianos extraídos da estrutura PROPVARIANT de origem.

[out] pcElem

Tipo: ULONG*

Quando essa função retorna, contém a contagem de elementos boolianos extraídos da estrutura PROPVARIANT de origem.

Valor retornado

Tipo: HRESULT

Essa função pode retornar um desses valores.

Código de retorno Descrição
S_OK
 Retorna S_OK se tiver êxito ou um valor de erro, caso contrário.
E_INVALIDARG
 OPROPVARIANT não era do tipo apropriado.

Comentários

Essa função auxiliar é usada em locais em que o aplicativo de chamada espera que um PROPVARIANT mantenha um valor de vetor booliano.

Se o PROPVARIANT de origem tiver o tipo VT_VECTOR | VT_BOOL ou VT_ARRAY | VT_BOOL, essa função extrai um vetor de valores boolianos em um vetor recém-alocado de valores BOOL . O aplicativo de chamada é responsável por usar CoTaskMemFree para liberar o vetor apontado por pprgf quando ele não for mais necessário.

Exemplos

O exemplo a seguir, a ser incluído como parte de um programa maior, demonstra como usar PropVariantToBooleanVectorAlloc para acessar um valor de vetor booliano em um PROPVARIANT.

// PROPVARIANT propvar;
// Assume the variable propvar is initialized and valid. The application is 
// expecting propvar to contain a vector of Boolean values.
BOOL *prgFlags;
ULONG cFlags;
HRESULT hr = PropVariantToBooleanVectorAlloc(propvar, &prgFlags, &cFlags);

if (SUCCEEDED(hr))
{
     // The prgFlags variable now points to a vector that contains a count
     // of cFlags flags.
     CoTaskMemFree(prgFlags);
}

Requisitos

   
Cliente mínimo com suporte Windows XP com SP2, Windows Vista [somente aplicativos da área de trabalho]
Servidor mínimo com suporte Windows Server 2003 com SP1 [somente aplicativos da área de trabalho]
Plataforma de Destino Windows
Cabeçalho propvarutil.h
Biblioteca Propsys.lib
DLL Propsys.dll (versão 6.0 ou posterior)
Redistribuível Pesquisa da Área de Trabalho do Windows (WDS) 3.0

Confira também

InitPropVariantFromBooleanVector

IsPropVariantVector

PropVariantGetBooleanElem

PropVariantToBooleanVector