InitPropVariantFromBoolean-Funktion (propvarutil.h)

  • Artikel

Initialisiert eine bestimmte PROPVARIANT-Struktur als VT_BOOL unter Verwendung eines angegebenen booleschen Werts.

Syntax

HRESULT InitPropVariantFromBoolean(
  [in]  BOOL        fVal,
  [out] PROPVARIANT *ppropvar
);

Parameter

[in] fVal

Typ: BOOL

Quell-BOOL-Wert.

[out] ppropvar

Typ: PROPVARIANT*

Wenn diese Funktion zurückgibt, enthält die initialisierte PROPVARIANT-Struktur .

Rückgabewert

Typ: HRESULT

Wenn diese Funktion erfolgreich ist, gibt sie S_OK zurück. Andernfalls wird ein Fehlercode HRESULT zurückgegeben.

Hinweise

Dies ist eine Inlinefunktion, deren Quellcode im Header bereitgestellt wird. Sie ist in keiner .dll- oder LIB-Datei enthalten.

Beachten Sie, dass das speziell von dieser Funktion initialisierte boolVal-Element vom Typ VARIANT_BOOL ist und daher Werte VARIANT_TRUE oder VARIANT_FALSE haben kann. Wenn Sie direkt mit diesem Strukturmember arbeiten, verwenden Sie diese Konstanten anstelle von TRUE oder FALSE , da VARIANT_TRUE nicht gleich TRUE und sizeof(VARIANT_TRUE) nicht mit sizeof(TRUE) identisch ist.

Beispiele

Im folgenden Beispiel, das als Teil eines größeren Programms eingeschlossen werden soll, wird die Verwendung von InitPropVariantFromBoolean veranschaulicht.

PROPVARIANT propvar;

HRESULT hr = InitPropVariantFromBoolean(TRUE, &propvar);

if (SUCCEEDED(hr))
{
    // propvar now is valid and has type VT_BOOL.
 
    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
Verteilbare Komponente Windows Desktop Search (WDS) 3.0

Weitere Informationen

InitPropVariantFromBooleanVector

InitVariantFromBoolean

PropVariantToBoolean