PropVariantToUInt32WithDefault-Funktion (propvarutil.h)
Extrahiert einen ULONG-Wert aus einer PROPVARIANT-Struktur . Wenn kein Wert vorhanden ist, wird ein angegebener Standardwert zurückgegeben.
Syntax
PSSTDAPI_(ULONG) PropVariantToUInt32WithDefault(
[in] REFPROPVARIANT propvarIn,
[in] ULONG ulDefault
);
Parameter
[in] propvarIn
Typ: REFPROPVARIANT
Verweis auf eine PROPVARIANT-Quellstruktur .
[in] ulDefault
Typ: ULONG
Gibt einen Standardeigenschaftswert für die Verwendung an, wenn derzeit kein Wert vorhanden ist.
Rückgabewert
Typ: ULONG
Gibt den extrahierten ULONG-Wert oder den Standardwert zurück.
Hinweise
Diese Hilfsfunktion wird an Stellen verwendet, an denen die aufrufende Anwendung erwartet, dass ein PROPVARIANT einen ULONG-Wert enthält, und wenn dies nicht der Fall ist, einen Standardwert verwenden möchte. 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 die PROPVARIANT-Quelle den Typ VT_EMPTY aufweist oder eine Konvertierung nicht möglich ist, gibt PropVariantToUInt32WithDefault den von ulDefault bereitgestellten Standardwert zurück. Eine Liste der möglichen Konvertierungen finden Sie unter PropVariantChangeType .
Beispiele
Im folgenden Beispiel, das als Teil eines größeren Programms eingeschlossen werden soll, wird veranschaulicht, wie PropVariantToUInt32WithDefault 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.
// The application developer decided to treat VT_EMPTY or invalid values as 0
ULONG uRating = PropVariantToUInt32WithDefault(propvar, 0);
// uRating is now valid.
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 |