Função VariantToBooleanWithDefault (propvarutil.h)
Extrai um valor BOOL de uma estrutura VARIANT . Se nenhum valor existir, o valor padrão especificado será retornado.
Sintaxe
PSSTDAPI_(BOOL) VariantToBooleanWithDefault(
[in] REFVARIANT varIn,
[in] BOOL fDefault
);
Parâmetros
[in] varIn
Tipo: REFVARIANT
Referência a uma estrutura VARIANT de origem.
[in] fDefault
Tipo: BOOL
O valor padrão para uso em que nenhum valor extraível existe.
Retornar valor
Tipo: BOOL
Retorna o valor BOOL extraído; caso contrário, o valor padrão especificado em fDefault.
Comentários
Essa função auxiliar é usada quando o aplicativo de chamada espera que um VARIANT mantenha um valor BOOL e deseja usar um valor padrão se não o fizer.
Se o VARIANT de origem for do tipo VT_BOOL, esse auxiliar extrairá o valor BOOL .
Se o VARIANT de origem não for do tipo VT_BOOL, a função tentará converter o valor na VARIANT em um BOOL.
Se o VARIANT de origem for do tipo VT_EMPTY ou uma conversão não for possível, VariantToBooleanWithDefault retornará o valor 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 VariantToBooleanWithDefault para acessar um valor BOOL armazenado em uma estrutura VARIANT .
// VARIANT var;
// Assume variable var is initialized and valid.
// The application expects var to hold a BOOL value.
// The application treats VT_EMPTY as FALSE.
BOOL fValue = VariantToBooleanWithDefault(var, FALSE);
// fValue is now valid.
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 |