Funzione VariantToBooleanWithDefault (propvarutil.h)

Articolo
03/01/2024

Estrae un valore BOOL da una struttura VARIANT . Se non esiste alcun valore, viene restituito il valore predefinito specificato.

Sintassi

PSSTDAPI_(BOOL) VariantToBooleanWithDefault(
  [in] REFVARIANT varIn,
  [in] BOOL       fDefault
);

Parametri

[in] varIn

Tipo: REFVARIANT

Riferimento a una struttura VARIANT di origine.

[in] fDefault

Tipo: BOOL

Valore predefinito da utilizzare in cui non esiste alcun valore estraibile.

Valore restituito

Tipo: BOOL

Restituisce il valore BOOL estratto; in caso contrario, il valore predefinito specificato in fDefault.

Commenti

Questa funzione helper viene usata quando l'applicazione chiamante prevede che un valore VARIANT contenga un valore BOOL e voglia usare un valore predefinito se non lo è.

Se l'origine VARIANT è di tipo VT_BOOL, questo helper estrae il valore BOOL .

Se l'origine VARIANT non è di tipo VT_BOOL, la funzione tenta di convertire il valore in VARIANT in un valore BOOL.

Se l'origine VARIANT è di tipo VT_EMPTY o non è possibile eseguire una conversione, VariantToBooleanWithDefault restituisce il valore predefinito fornito da fDefault. Per un elenco delle conversioni possibili, vedere PropVariantChangeType .

Esempio

Nell'esempio seguente, da includere come parte di un programma più ampio, viene illustrato come usare VariantToBooleanWithDefault per accedere a un valore BOOL archiviato in una struttura 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.

Requisiti

Requisito	Valore
Client minimo supportato	Windows XP con SP2, Windows Vista [solo app desktop]
Server minimo supportato	Windows Server 2003 con SP1 [solo app desktop]
Piattaforma di destinazione	Windows
Intestazione	propvarutil.h
Libreria	Propsys.lib
DLL	Propsys.dll (versione 6.0 o successiva)
Componente ridistribuibile	Windows Desktop Search (WDS) 3.0