PropVariantGetInt16Elem function

Extracts a single Int16 element from a PROPVARIANT structure of type VT_I2, VT_VECTOR | VT_I2, or VT_ARRAY | VT_I2.

Syntax


HRESULT PropVariantGetInt16Elem(
  _In_  REFPROPVARIANT propvar,
  _In_  ULONG          iElem,
  _Out_ SHORT          *pnVal
);

Parameters

propvar [in]

Type: REFPROPVARIANT

Reference to the source PROPVARIANT structure.

iElem [in]

Type: ULONG

The vector or array index; otherwise, this value must be 0.

pnVal [out]

Type: SHORT*

When this function returns, contains the extracted Int32 element value.

Return value

Type: HRESULT

If this function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

This helper function works for PROPVARIANT structures of the following types.

  • VT_I2
  • VT_VECTOR | VT_I2
  • VT_ARRAY | VT_I2

If the source PROPVARIANT has type VT_I2, iElem must be 0. Otherwise, iElem must be less than the number of elements in the vector or array. You can use PropVariantGetElementCount to obtain the number of elements in the vector or array.

Examples

The following example, to be included as part of a larger program, demonstrates how to use PropVariantGetInt16Elem with an iteration statement to access the values in a PROPVARIANT.


// PROPVARIANT propvar;
    // Assume propvar is initialized and valid;
    
    if ((propvar.vt & VT_TYPEMASK) == VT_I2)
    {
        UINT cElem = PropVariantGetElementCount(propvar);
        HRESULT hr = <mark type="const">S_OK</mark>;
    
        for (UINT iElem = 0; SUCCEEDED(hr) && iElem < cElem; iElem ++)
        {
            SHORT nValue;
            hr = PropVariantGetInt16Elem(propvar, iElem, &nValue);
    
            if (SUCCEEDED(hr))
            {
                // nValue is valid now
            }
        }
    }

Requirements

Minimum supported client

Windows XP with SP2, Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2003 with SP1 [desktop apps only]

Redistributable

Windows Desktop Search (WDS) 3.0

Header

Propvarutil.h

Library

Propsys.lib

DLL

Propsys.dll (version 6.0 or later)

See also

PropVariantGetElem

 

 

Show: