Fonction PropVariantToInt32WithDefault (propvarutil.h)
Extrait une valeur Int32 d’une structure PROPVARIANT . Si aucune valeur n’existe actuellement, la valeur par défaut spécifiée est retournée.
Syntaxe
PSSTDAPI_(LONG) PropVariantToInt32WithDefault(
[in] REFPROPVARIANT propvarIn,
[in] LONG lDefault
);
Paramètres
[in] propvarIn
Type : REFPROPVARIANT
Référence à une structure PROPVARIANT source.
[in] lDefault
Type : LONG
Spécifie une valeur de propriété par défaut, à utiliser lorsqu’aucune valeur n’existe actuellement.
Valeur retournée
Type : LONG
Retourne la valeur LONG 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 LONG 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 LONG des propriétés Int32.
Si la propriété PROPVARIANT source a le type VT_I4, cette fonction d’assistance extrait la valeur LONG . Sinon, il tente de convertir la valeur de la structure PROPVARIANT en long. Si le PROPVARIANT source a le type VT_EMPTY ou si une conversion n’est pas possible, PropVariantToInt32WithDefault retourne la valeur par défaut fournie par lDefault. Pour obtenir la liste des conversions possibles, consultez PropVariantChangeType .
Exemples
L’exemple suivant, à inclure dans un programme plus grand, montre comment utiliser PropVariantToInt32WithDefault pour accéder à une valeur LONG dans un PROPVARIANT.
// IPropertyStore *ppropstore;
// Assume variable ppropstore is initialized and valid
PROPVARIANT propvar = {0};
HRESULT hr = ppropstore->GetValue(PKEY_FlagStatus, &propvar);
if (SUCCEEDED(hr))
{
// PKEY_FlagStatus is expected to produce a VT_I4 or VT_EMPTY value.
// The application developer decided to treat VT_EMPTY or invalid values as 0
LONG iStatus = PropVariantToInt32WithDefault(propvar, 0);
// iStatus 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 |