Funzione VariantToBoolean (propvarutil.h)

Articolo
03/01/2024

Estrae il valore di una proprietà booleana da una struttura VARIANT . Se non è possibile estrarre alcun valore, viene assegnato un valore predefinito.

Sintassi

PSSTDAPI VariantToBoolean(
  [in]  REFVARIANT varIn,
  [out] BOOL       *pfRet
);

Parametri

[in] varIn

Tipo: REFVARIANT

Riferimento a una struttura VARIANT di origine.

[out] pfRet

Tipo: BOOL*

Quando questa funzione viene restituita, contiene il valore estratto, se presente; in caso contrario, FALSE.

Valore restituito

Tipo: HRESULT

Se questa funzione ha esito positivo, restituisce S_OK. In caso contrario, restituisce un codice di errore HRESULT .

Commenti

Questa funzione helper viene usata quando l'applicazione chiamante prevede che un valore VARIANT contenga un valore booleano. Ad esempio, un'applicazione che ottiene valori da una cartella shell può usare questa funzione per estrarre in modo sicuro il valore da una delle proprietà booleane della cartella.

Se l'origine VARIANT è di tipo VT_BOOL, questa funzione estrae il valore BOOL .

Se l'origine VARIANT non è di tipo VT_BOOL, questa funzione tenta di convertire il valore nella struttura VARIANT in un valore BOOL. Se una conversione non è possibile, VariantToBoolean restituisce un codice di errore e imposta pfRet su FALSE. Per un elenco delle conversioni possibili, vedere PropVariantChangeType . Si noti che VT_EMPTY viene convertito correttamente in FALSE.

Esempio

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

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