Função VariantToBoolean (propvarutil.h)
Extrai o valor de uma propriedade booliana de uma estrutura VARIANT . Se nenhum valor puder ser extraído, um valor padrão será atribuído.
Sintaxe
PSSTDAPI VariantToBoolean(
[in] REFVARIANT varIn,
[out] BOOL *pfRet
);
Parâmetros
[in] varIn
Tipo: REFVARIANT
Referência a uma estrutura VARIANT de origem.
[out] pfRet
Tipo: BOOL*
Quando essa função retorna, contém o valor extraído se houver um; caso contrário, FALSE.
Retornar valor
Tipo: HRESULT
Se essa função for bem-sucedida, ela retornará S_OK. Caso contrário, ele retornará um código de erro HRESULT.
Comentários
Essa função auxiliar é usada quando o aplicativo de chamada espera que um VARIANT mantenha um valor booliano. Por exemplo, um aplicativo que obtém valores de uma pasta Shell pode usar essa função para extrair com segurança o valor de uma das propriedades boolianas da pasta.
Se a VARIANT de origem for do tipo VT_BOOL, essa função extrairá o valor BOOL .
Se a VARIANT de origem não for do tipo VT_BOOL, essa função tentará converter o valor na estrutura VARIANT em um BOOL. Se uma conversão não for possível, VariantToBoolean retornará um código de falha e definirá pfRet como FALSE. Consulte PropVariantChangeType para obter uma lista de conversões possíveis. Observe que VT_EMPTY é convertido com êxito em FALSE.
Exemplos
O exemplo a seguir, a ser incluído como parte de um programa maior, demonstra como usar VariantToBoolean para acessar um valor BOOL em uma VARIANT.
// VARIANT var;
// Assume variable var is initialize and valid.
// The application expects it to hold a VT_BOOL value.
BOOL fValue;
HRESULT hr = VariantToBoolean(var, &fValue);
if (SUCCEEDED(hr))
{
// fValue is now valid.
}
else
{
// fValue is always FALSE.
}
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 |