PropVariantGetUInt16Elem-Funktion (propvarutil.h)

Artikel
03/01/2024

Extrahiert ein einzelnes nicht signiertes Int16-Element aus einer PROPVARIANT-Struktur vom Typ VT_U12, VT_VECTOR | VT_U12 oder VT_ARRAY | VT_U12.

Syntax

PSSTDAPI PropVariantGetUInt16Elem(
  [in]  REFPROPVARIANT propvar,
  [in]  ULONG          iElem,
  [out] USHORT         *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: USHORT*

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

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_UI2
VT_VECTOR | VT_UI2
VT_ARRAY | VT_UI2

Wenn die PROPVARIANT-Quelle den Typ VT_UI2 hat, 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.

Beispiele

Im folgenden Beispiel, das als Teil eines größeren Programms eingeschlossen werden soll, wird veranschaulicht, wie PropVariantGetUInt16Elem mit einer Iterationsanweisung verwendet wird, um auf die Werte in einem PROPVARIANT zuzugreifen.

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

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

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

        if (SUCCEEDED(hr))
        {
            // nValue 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

Freigeben über