PropVariantToDoubleWithDefault, fonction (propvarutil.h)
Extrait une valeur de propriété double d’une structure PROPVARIANT . Si aucune valeur n’existe, la valeur par défaut spécifiée est retournée.
Syntaxe
PSSTDAPI_(DOUBLE) PropVariantToDoubleWithDefault(
[in] REFPROPVARIANT propvarIn,
[in] DOUBLE dblDefault
);
Paramètres
[in] propvarIn
Type : REFPROPVARIANT
Référence à une structure PROPVARIANT source.
[in] dblDefault
Type : DOUBLE
Spécifie la valeur de propriété par défaut, à utiliser lorsqu’il n’existe actuellement aucune valeur.
Valeur retournée
Type : DOUBLE
Retourne la valeur double 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’un PROPVARIANT contienne une valeur double 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 double des propriétés doubles.
Si la source PROPVARIANT a le type VT_R8, cette fonction d’assistance extrait la double valeur. Sinon, il tente de convertir la valeur de la structure PROPVARIANT en double. Si la source PROPVARIANT a le type VT_EMPTY ou si une conversion n’est pas possible, PropVariantToDoubleWithDefault retourne la valeur par défaut fournie par dblDefault. Pour obtenir la liste des conversions possibles, consultez PropVariantChangeType .
Exemples
// IPropertyStore *ppropstore;
// Assume variable ppropstore is initialized and valid
PROPVARIANT propvar = {0};
HRESULT hr = ppropstore->GetValue(PKEY_Image_HorizontalResolution, &propvar);
if (SUCCEEDED(hr))
{
// PKEY_Image_HorizontalResolution is expected to produce a VT_R8 or VT_EMPTY value.
// The application developer decided to treat VT_EMPTY or invalid values as 72.0
DOUBLE dblResolution = PropVariantToDoubleWithDefault(propvar, 72.0);
// dblResolution 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 |