Fonction PropVariantToBooleanWithDefault (propvarutil.h)

Article
03/04/2024

Extrait la valeur de la propriété booléenne d’une structure PROPVARIANT . Si aucune valeur n’existe, la valeur par défaut spécifiée est retournée.

Syntaxe

PSSTDAPI_(BOOL) PropVariantToBooleanWithDefault(
  [in] REFPROPVARIANT propvarIn,
  [in] BOOL           fDefault
);

Paramètres

[in] propvarIn

Type : REFPROPVARIANT

Référence à une structure PROPVARIANT source.

[in] fDefault

Type : BOOL

Spécifie la valeur de la propriété par défaut, à utiliser lorsqu’aucune valeur n’existe actuellement.

Valeur retournée

Type : BOOL

Valeur booléenne extraite ou valeur par défaut.

Remarques

Cette fonction d’assistance est utilisée dans les endroits où l’application appelante s’attend à ce qu’une propriété PROPVARIANT contienne une valeur booléenne et souhaite utiliser une valeur par défaut si ce n’est pas le cas. Par instance, une application qui obtient des valeurs à partir d’un magasin de propriétés peut l’utiliser pour extraire en toute sécurité la valeur booléenne pour les propriétés booléennes.

Si la propriété PROPVARIANT source a le type VT_BOOL, cette fonction d’assistance extrait la valeur booléenne. Sinon, il tente de convertir la valeur de la structure PROPVARIANT en booléen. Si la source PROPVARIANT a le type VT_EMPTY ou si une conversion n’est pas possible, PropVariantToBooleanWithDefault 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 grand, montre comment utiliser PropVariantToBooleanWithDefault pour accéder à une valeur booléenne dans un PROPVARIANT.

// IPropertyStore *ppropstore;
// Assume the variable ppropstore is initialized and valid.
PROPVARIANT propvar = {0};
HRESULT hr = ppropstore->GetValue(PKEY_IsRead, &propvar);

if (SUCCEEDED(hr))
{
     // PKEY_IsRead is expected to produce a VT_BOOL or VT_EMPTY value.
     // The application developer decided to treat VT_EMPTY or invalid values as TRUE
     BOOL fShared = PropVariantToBooleanWithDefault(propvar, TRUE);
     
     // fShared is now valid.
     PropVariantClear(&propvar);
}

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

Partager via