PropVariantToUInt16WithDefault-Funktion (propvarutil.h)
Extrahiert einen unsignierten kurzen Wert aus einer PROPVARIANT-Struktur . Wenn kein Wert vorhanden ist, wird der angegebene Standardwert zurückgegeben.
Syntax
PSSTDAPI_(USHORT) PropVariantToUInt16WithDefault(
[in] REFPROPVARIANT propvarIn,
[in] USHORT uiDefault
);
Parameter
[in] propvarIn
Typ: REFPROPVARIANT
Verweis auf eine PROPVARIANT-Quellstruktur .
[in] uiDefault
Typ: USHORT
Gibt einen Standardwert für Die Verwendung an, wenn derzeit kein Wert vorhanden ist.
Rückgabewert
Typ: unsigned short
Gibt den extrahierten Unsigned Short-Wert oder den Standardwert zurück.
Hinweise
Diese Hilfsfunktion wird an Stellen verwendet, an denen die aufrufende Anwendung erwartet, dass eine PROPVARIANT einen unsignierten kurzen Wert enthält. Für instance kann eine Anwendung, die Werte aus einem Eigenschaftenspeicher bezieht, dies verwenden, um den unsignierten Kurzwert für UInt16-Eigenschaften sicher zu extrahieren.
Wenn die Propvariant-Quelleden Typ VT_UI2 hat, extrahiert diese Hilfsfunktion den unsignierten Kurzwert . Andernfalls wird versucht, den Wert in der PROPVARIANT-Struktur in eine kurz ohne Vorzeichen zu konvertieren. Wenn eine Konvertierung nicht möglich ist, gibt PropVariantToUInt16 einen Fehlercode zurück und legt puiRet auf 0 fest. Eine Liste möglicher 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 PropVariantToUInt16 verwendet wird, um auf einen nicht signierten short-Wert in einer PROPVARIANT-Datei zuzugreifen.
// IPropertyStore *ppropstore;
// Assume variable ppropstore is initialized and valid
PROPVARIANT propvar = {0};
HRESULT hr = ppropstore->GetValue(PKEY_FlagColor, &propvar);
if (SUCCEEDED(hr))
{
// PKEY_FlagColor is expected to produce a VT_UI2 or VT_EMPTY value.
// PropVariantToInt32 will convert VT_EMPTY to 0.
USHORT uColor;
hr = PropVariantToUInt32(propvar, & uColor);
if (SUCCEEDED(hr))
{
// uColor is now valid
}
else
{
// uColor 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 |