PropVariantToUInt64WithDefault, fonction (propvarutil.h)

Article
03/01/2024

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

Syntaxe

PSSTDAPI_(ULONGLONG) PropVariantToUInt64WithDefault(
  [in] REFPROPVARIANT propvarIn,
  [in] ULONGLONG      ullDefault
);

Paramètres

[in] propvarIn

Type : REFPROPVARIANT

Référence à une structure PROPVARIANT source.

[in] ullDefault

Type : ULONGLONG

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

Valeur retournée

Type : ULONGLONG

Retourne la valeur LONGLONG non signée extraite, ou une 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 ULONGLONG 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 ULONGLONG pour les propriétés UInt64.

Si la source PROPVARIANT a le type VT_UI8, cette fonction d’assistance extrait la valeur ULONGLONG . Sinon, il tente de convertir la valeur de la structure PROPVARIANT en ULONGLONG. Si la source PROPVARIANT a le type VT_EMPTY ou si une conversion n’est pas possible, PropVariantToUInt64WithDefault retourne la valeur par défaut fournie par ullDefault. 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 PropVariantToUInt64WithDefault pour accéder à une valeur ULONGLONG dans un PROPVARIANT.

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