PropVariantToUInt32-Funktion (propvarutil.h)
Extrahiert einen ULONG-Wert aus einer PROPVARIANT-Struktur . Wenn kein Wert extrahiert werden kann, wird ein Standardwert zugewiesen.
Syntax
PSSTDAPI PropVariantToUInt32(
[in] REFPROPVARIANT propvarIn,
[out] ULONG *pulRet
);
Parameter
[in] propvarIn
Typ: REFPROPVARIANT
Ein Verweis auf eine PROPVARIANT-Quellstruktur .
[out] pulRet
Typ: ULONG*
Wenn diese Funktion zurückgibt, enthält den extrahierten Eigenschaftswert, 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 ULONG-Wert enthält. Für instance kann eine Anwendung, die Werte aus einem Eigenschaftenspeicher erhält, dies verwenden, um den ULONG-Wert für UInt32-Eigenschaften sicher zu extrahieren.
Wenn die PROPVARIANT-Quelleden Typ VT_UI4 hat, extrahiert diese Hilfsfunktion den ULONG-Wert . Andernfalls wird versucht, den Wert in der PROPVARIANT-Struktur in eine ULONG zu konvertieren. Wenn eine Konvertierung nicht möglich ist, gibt PropVariantToUInt32 einen Fehlercode zurück und legt pulRet auf 0 fest. Eine Liste der möglichen Konvertierungen finden Sie unter PropVariantChangeType . Beachten Sie, dass VT_EMPTY erfolgreich in 0 konvertiert wurde.
Beispiele
Im folgenden Beispiel, das als Teil eines größeren Programms eingeschlossen werden soll, wird veranschaulicht, wie PropVariantToUInt32 verwendet wird, um auf einen ULONG-Wert in einem PROPVARIANT zuzugreifen.
// IPropertyStore *ppropstore;
// Assume variable ppropstore is initialized and valid
PROPVARIANT propvar = {0};
HRESULT hr = ppropstore->GetValue(PKEY_Rating, &propvar);
if (SUCCEEDED(hr))
{
// PKEY_Rating is expected to produce a VT_UI4 or VT_EMPTY value.
// PropVariantToUInt32 will convert VT_EMPTY to 0.
ULONG uRating;
hr = PropVariantToUInt32(propvar, &uRating);
if (SUCCEEDED(hr))
{
// uRating is now valid
}
else
{
// uRating 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 |