Fonction VariantToBooleanWithDefault (propvarutil.h)

Article
03/01/2024

Extrait une valeur BOOL d’une structure VARIANT . Si aucune valeur n’existe, la valeur par défaut spécifiée est retournée.

Syntaxe

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

Paramètres

[in] varIn

Type : REFVARIANT

Référence à une structure VARIANT source.

[in] fDefault

Type : BOOL

Valeur par défaut à utiliser lorsqu’il n’existe aucune valeur extractible.

Valeur retournée

Type : BOOL

Retourne la valeur BOOL extraite ; sinon, valeur par défaut spécifiée dans fDefault.

Remarques

Cette fonction d’assistance est utilisée lorsque l’application appelante s’attend à ce qu’un VARIANT contienne une valeur BOOL et souhaite utiliser une valeur par défaut si ce n’est pas le cas.

Si le VARIANT source est de type VT_BOOL, cette assistance extrait la valeur BOOL .

Si le VARIANT source n’est pas de type VT_BOOL, la fonction tente de convertir la valeur dans le VARIANT en boOL.

Si le VARIANT source est de type VT_EMPTY ou si une conversion n’est pas possible, VariantToBooleanWithDefault retourne la valeur par défaut fournie par fDefault. Pour obtenir la liste des conversions possibles, consultez PropVariantChangeType .

Exemples

L’exemple suivant, à inclure dans le cadre d’un programme plus large, montre comment utiliser VariantToBooleanWithDefault pour accéder à une valeur BOOL stockée dans une structure 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.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows XP avec SP2, Windows Vista [applications de bureau uniquement]
Serveur minimal pris en charge	Windows Server 2003 avec SP1 [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	propvarutil.h
Bibliothèque	Propsys.lib
DLL	Propsys.dll (version 6.0 ou ultérieure)
Composant redistribuable	Windows Desktop Search (WDS) 3.0