Fonction PropVariantToUInt32WithDefault (propvarutil.h)

Article
03/13/2024

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

Syntaxe

PSSTDAPI_(ULONG) PropVariantToUInt32WithDefault(
  [in] REFPROPVARIANT propvarIn,
  [in] ULONG          ulDefault
);

Paramètres

[in] propvarIn

Type : REFPROPVARIANT

Référence à une structure PROPVARIANT source.

[in] ulDefault

Type : ULONG

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

Valeur retournée

Type : ULONG

Retourne la valeur ULONG extraite ou la valeur par défaut.

Remarques

Cette fonction d’assistance est utilisée dans les endroits où l’application appelante s’attend à ce qu’un PROPVARIANT contienne une valeur ULONG 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 ULONG des propriétés UInt32.

Si la propriété PROPVARIANT source a le type VT_UI4, cette fonction d’assistance extrait la valeur ULONG . Sinon, il tente de convertir la valeur de la structure PROPVARIANT en ULONG. Si le PROPVARIANT source a le type VT_EMPTY ou si une conversion n’est pas possible, PropVariantToUInt32WithDefault retourne la valeur par défaut fournie par ulDefault. Pour obtenir la liste des conversions possibles, consultez PropVariantChangeType .

Exemples

L’exemple suivant, à inclure dans un programme plus grand, montre comment utiliser PropVariantToUInt32WithDefault pour accéder à une valeur ULONG dans un PROPVARIANT.

// IPropertyStore *ppropstore;
// Assume variable ppropstore is initialized and valid
PROPVARIANT propvar = {0};
HRESULT hr = ppropstore->GetValue(PKEY_Rating, &propvar);
if (SUCCEEDED(hr))
{
     // PKEY_Rating is expected to produce a VT_UI4 or VT_EMPTY value.
     // The application developer decided to treat VT_EMPTY or invalid values as 0
     ULONG uRating = PropVariantToUInt32WithDefault(propvar, 0);
     // uRating 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