Funzione PropVariantToUInt16VectorAlloc (propvarutil.h)

Articolo
03/05/2024

Estrae i dati da una struttura PROPVARIANT in un vettore short senza segno appena allocato.

Sintassi

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

Parametri

[in] propvar

Tipo: REFPROPVARIANT

Riferimento a una struttura PROPVARIANT di origine.

[out] pprgn

Tipo: USHORT**

Quando termina, questa funzione contiene un puntatore a un vettore di valori brevi senza segno estratti dalla struttura PROPVARIANT di origine.

[out] pcElem

Tipo: ULONG*

Quando termina, questa funzione contiene il numero di valori brevi senza segno estratti dalla struttura PROPVARIANT di origine.

Valore restituito

Tipo: HRESULT

Questa funzione può restituire uno di questi valori.

Codice restituito	Descrizione
S_OK	Restituisce S_OK in caso di esito positivo o un valore di errore in caso contrario
E_INVALIDARG	PropVARIANT non era del tipo appropriato.

Commenti

Questa funzione helper viene usata in posizioni in cui l'applicazione chiamante prevede che un PROPVARIANT contenga un vettore di valori brevi senza segno .

Se l'origine PROPVARIANT ha tipo VT_VECTOR VT_UI2 | oVT_ARRAY VT_UI2 | , questa funzione estrae un vettore di valori brevi senza segno in un vettore appena allocato. L'applicazione chiamante è responsabile dell'uso di CoTaskMemFree per rilasciare il vettore a cui punta pprgn quando non è più necessario.

Esempio

Nell'esempio seguente, da includere come parte di un programma più ampio, viene illustrato come usare PropVariantToUInt16VectorAlloc per accedere a un valore di vettore breve senza segno in un 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);
}

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