Funzione PropVariantGetUInt16Elem (propvarutil.h)

Articolo
03/01/2024

Estrae un singolo elemento Int16 da una struttura PROPVARIANT di tipo VT_U12, VT_VECTOR | VT_U12 o VT_ARRAY | VT_U12.

Sintassi

PSSTDAPI PropVariantGetUInt16Elem(
  [in]  REFPROPVARIANT propvar,
  [in]  ULONG          iElem,
  [out] USHORT         *pnVal
);

Parametri

[in] propvar

Tipo: REFPROPVARIANT

Riferimento alla struttura PROPVARIANT di origine.

[in] iElem

Tipo: ULONG

Vettore o indice matrice; in caso contrario, iElem deve essere 0.

[out] pnVal

Tipo: USHORT*

Quando questa funzione restituisce, contiene il valore dell'elemento estratto.

Valore restituito

Tipo: HRESULT

Se questa funzione ha esito positivo, restituisce S_OK. In caso contrario, restituisce un codice di errore HRESULT .

Commenti

Questa funzione helper funziona per le strutture PROPVARIANT dei tipi seguenti:

VT_UI2
VT_VECTOR | VT_UI2
VT_ARRAY | VT_UI2

Se l'origine PROPVARIANT ha tipo VT_UI2, iElem deve essere 0. In caso contrario, iElem deve essere minore del numero di elementi nel vettore o nella matrice. È possibile usare PropVariantGetElementCount per ottenere il numero di elementi nel vettore o nella matrice.

Esempio

Nell'esempio seguente, da includere come parte di un programma più ampio, viene illustrato come usare PropVariantGetUInt16Elem con un'istruzione iterazione per accedere ai valori in un PROPVARIANT.

// 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
        }
    }
}

Requisiti

Requisito	Valore
Client minimo supportato	Windows XP con SP2, Windows Vista [solo app desktop]
Server minimo supportato	Windows Server 2003 con SP1 [solo app desktop]
Piattaforma di destinazione	Windows
Intestazione	propvarutil.h
Libreria	Propsys.lib
DLL	Propsys.dll (versione 6.0 o successiva)
Componente ridistribuibile	Windows Desktop Search (WDS) 3.0

Condividi tramite