VariantToBooleanWithDefault-Funktion (propvarutil.h)

Artikel
08/25/2023

Extrahiert einen BOOL-Wert aus einer VARIANT-Struktur . Wenn kein Wert vorhanden ist, wird der angegebene Standardwert zurückgegeben.

Syntax

PSSTDAPI_(BOOL) VariantToBooleanWithDefault(
  [in] REFVARIANT varIn,
  [in] BOOL       fDefault
);

Parameter

[in] varIn

Typ: REFVARIANT

Verweis auf eine VARIANT-Quellstruktur .

[in] fDefault

Typ: BOOL

Der Standardwert für die Verwendung, wenn kein extrahierter Wert vorhanden ist.

Rückgabewert

Typ: BOOL

Gibt den extrahierten BOOL-Wert zurück. andernfalls der in fDefault angegebene Standardwert.

Hinweise

Diese Hilfsfunktion wird verwendet, wenn die aufrufende Anwendung erwartet, dass ein VARIANT-Wert einen BOOL-Wert enthält und andernfalls einen Standardwert verwenden möchte.

Wenn die Variant-Quelle vom Typ VT_BOOL ist, extrahiert dieses Hilfsprogramm den BOOL-Wert .

Wenn der Variant-Quelltyp nicht vom Typ VT_BOOL ist, versucht die Funktion, den Wert im VARIANT-Objekt in einen BOOL-Wert zu konvertieren.

Wenn der Variant-Quelltyp vom Typ VT_EMPTY ist oder eine Konvertierung nicht möglich ist, gibt VariantToBooleanWithDefault den von fDefault 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 VariantToBooleanWithDefault für den Zugriff auf einen in einer VARIANT-Struktur gespeicherten BOOL-Wert verwendet wird.

// VARIANT var;
// Assume variable var is initialized and valid.  
// The application expects var to hold a BOOL value.
// The application treats VT_EMPTY as FALSE.

BOOL fValue = VariantToBooleanWithDefault(var, FALSE);

// fValue is now valid.

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