Compartilhar via

Função PropVariantGetUInt16Elem (propvarutil.h)

  • Artigo

Extrai um único elemento Int16 sem sinal de uma estrutura PROPVARIANT do tipo VT_U12, VT_VECTOR | VT_U12 ou VT_ARRAY | VT_U12.

Sintaxe

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

Parâmetros

[in] propvar

Tipo: REFPROPVARIANT

Referência à estrutura PROPVARIANT de origem.

[in] iElem

Tipo: ULONG

O vetor ou índice de matriz; caso contrário, iElem deve ser 0.

[out] pnVal

Tipo: USHORT*

Quando essa função retorna, contém o valor do elemento extraído.

Retornar valor

Tipo: HRESULT

Se essa função for bem-sucedida, ela retornará S_OK. Caso contrário, ele retornará um código de erro HRESULT.

Comentários

Essa função auxiliar funciona para estruturas PROPVARIANT dos seguintes tipos:

  • VT_UI2
  • VT_VECTOR | VT_UI2
  • VT_ARRAY | VT_UI2
Se o PROPVARIANT de origem tiver o tipo VT_UI2, iElem deverá ser 0. Caso contrário, iElem deve ser menor que o número de elementos no vetor ou na matriz. Você pode usar PropVariantGetElementCount para obter o número de elementos no vetor ou na matriz.

Exemplos

O exemplo a seguir, a ser incluído como parte de um programa maior, demonstra como usar PropVariantGetUInt16Elem com uma instrução de iteração para acessar os valores em um 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
        }
    }
}

Requisitos

Requisito Valor
Cliente mínimo com suporte Windows XP com SP2, Windows Vista [somente aplicativos da área de trabalho]
Servidor mínimo com suporte Windows Server 2003 com SP1 [somente aplicativos da área de trabalho]
Plataforma de Destino Windows
Cabeçalho propvarutil.h
Biblioteca Propsys.lib
DLL Propsys.dll (versão 6.0 ou posterior)
Redistribuível Pesquisa da Área de Trabalho do Windows (WDS) 3.0