Compartilhar via

Função PropVariantToBooleanWithDefault (propvarutil.h)

  • Artigo

Extrai o valor da propriedade booliana de uma estrutura PROPVARIANT . Se nenhum valor existir, o valor padrão especificado será retornado.

Sintaxe

PSSTDAPI_(BOOL) PropVariantToBooleanWithDefault(
  [in] REFPROPVARIANT propvarIn,
  [in] BOOL           fDefault
);

Parâmetros

[in] propvarIn

Tipo: REFPROPVARIANT

Referência a uma estrutura PROPVARIANT de origem .

[in] fDefault

Tipo: BOOL

Especifica o valor da propriedade padrão, para uso em que nenhum valor existe no momento.

Retornar valor

Tipo: BOOL

O valor booliano extraído ou o valor padrão.

Comentários

Essa função auxiliar é usada em locais em que o aplicativo de chamada espera que um PROPVARIANT mantenha um valor booliano e gostaria de usar um valor padrão se não o fizer. Por exemplo, um aplicativo que obtém valores de um repositório de propriedades pode usá-lo para extrair com segurança o valor booliano para propriedades boolianas.

Se o PROPVARIANT de origem tiver tipo VT_BOOL, essa função auxiliar extrairá o valor booliano. Caso contrário, ele tentará converter o valor na estrutura PROPVARIANT em um booliano. Se o PROPVARIANT de origem tiver o tipo VT_EMPTY ou uma conversão não for possível, PropVariantToBooleanWithDefault retornará o padrão fornecido por fDefault. Consulte PropVariantChangeType para obter uma lista de conversões possíveis.

Exemplos

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

// IPropertyStore *ppropstore;
// Assume the variable ppropstore is initialized and valid.
PROPVARIANT propvar = {0};
HRESULT hr = ppropstore->GetValue(PKEY_IsRead, &propvar);

if (SUCCEEDED(hr))
{
     // PKEY_IsRead is expected to produce a VT_BOOL or VT_EMPTY value.
     // The application developer decided to treat VT_EMPTY or invalid values as TRUE
     BOOL fShared = PropVariantToBooleanWithDefault(propvar, TRUE);
     
     // fShared is now valid.
     PropVariantClear(&propvar);
}

Requisitos

Requisito Valor
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