Fonction PropVariantToInt32 (propvarutil.h)
Extrait la valeur de la propriété Int32 d’une structure PROPVARIANT . Si aucune valeur ne peut être extraite, une valeur par défaut est affectée.
Syntaxe
PSSTDAPI PropVariantToInt32(
[in] REFPROPVARIANT propvarIn,
[out] LONG *plRet
);
Paramètres
[in] propvarIn
Type : REFPROPVARIANT
Référence à une structure PROPVARIANT source.
[out] plRet
Type : LONG*
Lorsque cette fonction retourne, contient la valeur extraite le cas échéant ; sinon, 0.
Valeur retournée
Type : HRESULT
Si cette fonction réussit, elle retourne S_OK. Sinon, elle retourne un code d’erreur HRESULT.
Remarques
Cette fonction d’assistance est utilisée dans les endroits où l’application appelante s’attend à ce qu’un PROPVARIANT contienne une valeur Int32 . 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 Int32 pour les 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 une conversion n’est pas possible, PropVariantToInt32 retourne un code d’échec et définit plRet sur 0. Pour obtenir la liste des conversions possibles, consultez PropVariantChangeType . Notez que VT_EMPTY est correctement converti en 0.
Exemples
// 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.
// PropVariantToInt32 will convert VT_EMPTY to 0.
INT32 iStatus;
hr = PropVariantToInt32(propvar, &iStatus);
if (SUCCEEDED(hr))
{
// iStatus is now valid
}
else
{
// iStatus is always 0
}
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 |