PropVariantGetBooleanElem-Funktion (propvarutil.h)

  • Artikel

Extrahiert ein einzelnes boolesches Element aus einer PROPVARIANT-Struktur vom Typ VT_BOOL, VT_VECTOR | VT_BOOLoder VT_ARRAY | VT_BOOL.

Syntax

PSSTDAPI PropVariantGetBooleanElem(
  [in]  REFPROPVARIANT propvar,
  [in]  ULONG          iElem,
  [out] BOOL           *pfVal
);

Parameter

[in] propvar

Typ: REFPROPVARIANT

Ein Verweis auf die PROPVARIANT-Quellstruktur .

[in] iElem

Typ: ULONG

Gibt den Vektor- oder Arrayindex an; Andernfalls muss iElem 0 sein.

[out] pfVal

Typ: BOOL*

Wenn diese Funktion zurückgibt, enthält den extrahierten booleschen Wert.

Rückgabewert

Typ: HRESULT

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

Hinweise

Wenn die PROPVARIANT-Quellstruktur den Typ VT_BOOLaufweist, muss iElem 0 sein. Andernfalls muss iElem kleiner als die Anzahl der Elemente im Vektor oder Array sein. Sie können PropVariantGetElementCount verwenden, um die Anzahl der Elemente im Vektor oder Array abzurufen.

Im folgenden Beispiel wird diese Funktion verwendet, um die Werte in einer PROPVARIANT-Struktur zu durchlaufen.

Beispiele

// PROPVARIANT propvar;
// assume propvar is initialized and valid

if ((propvar.vt & VT_TYPEMASK) == VT_BOOL)
{
    UINT cElem = PropVariantGetElementCount(propvar);
    HRESULT hr = <mark type="const">S_OK</mark>;
    
    for (UINT iElem = 0; SUCCEEDED(hr) && iElem < cElem; iElem ++)
    {
        BOOL fValue;
        hr = PropVariantGetBooleanElem(propvar, iElem, &fValue);
    
        if (SUCCEEDED(hr))
        {
            // fValue is valid now
        }
    }
}

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

Weitere Informationen

PropVariantGetElem