Funzione PropVariantToInt32 (propvarutil.h)
Estrae il valore della proprietà Int32 di una struttura PROPVARIANT . Se non è possibile estrarre alcun valore, viene assegnato un valore predefinito.
Sintassi
PSSTDAPI PropVariantToInt32(
[in] REFPROPVARIANT propvarIn,
[out] LONG *plRet
);
Parametri
[in] propvarIn
Tipo: REFPROPVARIANT
Riferimento a una struttura PROPVARIANT di origine.
[out] plRet
Tipo: LONG*
Quando questa funzione restituisce, contiene il valore estratto se presente; in caso contrario, 0.
Valore restituito
Tipo: HRESULT
Se questa funzione ha esito positivo, restituisce S_OK. In caso contrario, restituisce un codice di errore HRESULT .
Commenti
Questa funzione helper viene usata nelle posizioni in cui l'applicazione chiamante prevede che un VALORE PROPVARIANT contenga un valore Int32 . Ad esempio, un'applicazione che ottiene valori da un archivio proprietà può usare questa opzione per estrarre in modo sicuro il valore Int32 per le proprietà Int32.
Se l'origine PROPVARIANT ha tipo VT_I4, questa funzione helper estrae il valore lungo . In caso contrario, tenta di convertire il valore nella struttura PROPVARIANT in un lungo. Se una conversione non è possibile, PropVariantToInt32 restituirà un codice di errore e imposta plRet su 0. Per un elenco di possibili conversioni, vedere PropVariantChangeType . Nota, VT_EMPTY viene convertito correttamente in 0.
Esempio
// 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);
}
Requisiti
Requisito | Valore |
---|---|
Client minimo supportato | Windows XP con SP2, Windows Vista [solo app desktop] |
Server minimo supportato | Windows Server 2003 con SP1 [solo app desktop] |
Piattaforma di destinazione | Windows |
Intestazione | propvarutil.h |
Libreria | Propsys.lib |
DLL | Propsys.dll (versione 6.0 o successiva) |
Componente ridistribuibile | Windows Desktop Search (WDS) 3.0 |