PropVariantGetInt32Elem-Funktion (propvarutil.h)

Artikel
08/25/2023

Extrahiert ein einzelnes Int32-Element aus einer PROPVARIANT vom Typ VT_I4, VT_VECTOR | VT_I4 oder VT_ARRAY | VT_I4.

Syntax

PSSTDAPI PropVariantGetInt32Elem(
  [in]  REFPROPVARIANT propvar,
  [in]  ULONG          iElem,
  [out] LONG           *pnVal
);

Parameter

[in] propvar

Typ: REFPROPVARIANT

Verweis auf die PROPVARIANT-Quellstruktur .

[in] iElem

Typ: ULONG

Der Vektor- oder Arrayindex; Andernfalls muss iElem 0 sein.

[out] pnVal

Typ: LONG*

Wenn diese Funktion, enthält den extrahierten Int32-Wert.

Rückgabewert

Typ: HRESULT

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

Hinweise

Diese Hilfsfunktion funktioniert für PROPVARIANT-Strukturen der folgenden Typen:

VT_I4
VT_VECTTOR | VT_I4
VT_ARRAY | VT_I4

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

Beispiele

Im folgenden Beispiel wird dieses PropVariantGetInt32Elem mit einer Iterationsanweisung verwendet, um auf die Werte in einer PROPVARIANT-Struktur zuzugreifen.

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

if ((propvar.vt & VT_TYPEMASK) == VT_I4)
{
    UINT cElem = PropVariantGetElementCount(propvar);
    HRESULT hr = <mark type="const">S_OK</mark>;

    for (UINT iElem = 0; SUCCEEDED(hr) && iElem < cElem; iElem ++)
    {
        LONG nValue;
        hr = PropVariantGetInt32Elem(propvar, iElem, &nValue);

        if (SUCCEEDED(hr))
        {
            // nValue is valid now
        }
    }
}

Anforderungen


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

Freigeben über