Função PropVariantToUInt16VectorAlloc (propvarutil.h)

Artigo
08/25/2023

Extrai dados de uma estrutura PROPVARIANT em um vetor curto sem sinal recém-alocado.

Sintaxe

PSSTDAPI PropVariantToUInt16VectorAlloc(
  [in]  REFPROPVARIANT propvar,
  [out] USHORT         **pprgn,
  [out] ULONG          *pcElem
);

Parâmetros

[in] propvar

Tipo: REFPROPVARIANT

Referência a uma estrutura PROPVARIANT de origem .

[out] pprgn

Tipo: USHORT**

Quando essa função retorna, contém um ponteiro para um vetor de valores curtos sem sinal extraídos da estrutura PROPVARIANT de origem.

[out] pcElem

Tipo: ULONG*

Quando essa função retorna, contém a contagem de valores curtos não assinados extraídos da estrutura PROPVARIANT de origem.

Retornar valor

Tipo: HRESULT

Essa função pode retornar um desses valores.

Código de retorno	Descrição
S_OK	Retorna S_OK se tiver êxito ou um valor de erro, caso contrário,
E_INVALIDARG	O PROPVARIANT não era do tipo apropriado.

Comentários

Essa função auxiliar é usada em locais onde o aplicativo de chamada espera que um PROPVARIANT mantenha um vetor de valores curtos sem sinal .

Se o PROPVARIANT de origem tiver tipo VT_VECTOR | VT_UI2 ou VT_ARRAY | VT_UI2, essa função extrairá um vetor de valores curtos não assinados em um vetor recém-alocado. O aplicativo de chamada é responsável por usar CoTaskMemFree para liberar o vetor apontado pelo pprgn quando ele não for mais necessário.

Exemplos

O exemplo a seguir, a ser incluído como parte de um programa maior, demonstra como usar PropVariantToUInt16VectorAlloc para acessar um valor de vetor curto sem sinal em um PROPVARIANT.

// PROPVARIANT propvar;
// Assume the variable propvar is initialized and valid. The application is expecting propvar to contain a vector of <dtype rid="ushort"/> values.
USHORT *prgShorts;
ULONG cElems;
HRESULT hr = PropVariantToUInt16VectorAlloc(propvar, & prgShorts, &cElems);
if (SUCCEEDED(hr))
{
     // prgShorts now points to a vector of cElems USHORTs.
     CoTaskMemFree(prgShorts);
}

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