PropVariantToInt32-Funktion (propvarutil.h)
Extrahiert den Int32-Eigenschaftswert einer PROPVARIANT-Struktur . Wenn kein Wert extrahiert werden kann, wird ein Standardwert zugewiesen.
Syntax
PSSTDAPI PropVariantToInt32(
[in] REFPROPVARIANT propvarIn,
[out] LONG *plRet
);
Parameter
[in] propvarIn
Typ: REFPROPVARIANT
Verweis auf eine PROPVARIANT-Quellstruktur .
[out] plRet
Typ: LONG*
Wenn diese Funktion zurückgibt, enthält den extrahierten Wert, sofern vorhanden; andernfalls 0.
Rückgabewert
Typ: HRESULT
Wenn diese Funktion erfolgreich ist, wird S_OK zurückgegeben. Andernfalls wird ein Fehlercode HRESULT zurückgegeben.
Hinweise
Diese Hilfsfunktion wird an Stellen verwendet, an denen die aufrufende Anwendung erwartet, dass eine PROPVARIANT einen Int32-Wert enthält. Für instance kann eine Anwendung, die Werte aus einem Eigenschaftenspeicher erhält, dies verwenden, um den Int32-Wert für Int32-Eigenschaften sicher zu extrahieren.
Wenn die Quelle PROPVARIANT den Typ VT_I4 hat, extrahiert diese Hilfsfunktion den long-Wert . Andernfalls wird versucht, den Wert in der PROPVARIANT-Struktur in einen long-Wert zu konvertieren. Wenn eine Konvertierung nicht möglich ist, gibt PropVariantToInt32 einen Fehlercode zurück und legt plRet auf 0 fest. Eine Liste der möglichen Konvertierungen finden Sie unter PropVariantChangeType . Beachten Sie, dass VT_EMPTY erfolgreich in 0 konvertiert wurde.
Beispiele
// 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);
}
Anforderungen
Anforderung | Wert |
---|---|
Unterstützte Mindestversion (Client) | Windows XP mit SP2, Windows Vista [nur Desktop-Apps] |
Unterstützte Mindestversion (Server) | Windows Server 2003 mit SP1 [nur Desktop-Apps] |
Zielplattform | Windows |
Kopfzeile | propvarutil.h |
Bibliothek | Propsys.lib |
DLL | Propsys.dll (Version 6.0 oder höher) |
Verteilbare Komponente | Windows Desktop Search (WDS) 3.0 |