Funzione PropVariantToInt32Vector (propvarutil.h)

Articolo
03/05/2024

Estrae un vettore di valori lunghi da una struttura PROPVARIANT .

Sintassi

PSSTDAPI PropVariantToInt32Vector(
  [in]  REFPROPVARIANT propvar,
  [out] LONG           *prgn,
  [in]  ULONG          crgn,
  [out] ULONG          *pcElem
);

Parametri

[in] propvar

Tipo: REFPROPVARIANT

Riferimento a una struttura PROPVARIANT di origine.

[out] prgn

Tipo: LONG*

Punta a un buffer contenente valori LONG crgn. Quando questa funzione restituisce, il buffer è stato inizializzato con elementi LONG pcElem estratti dall'origine PROPVARIANT.

[in] crgn

Tipo: ULONG

Dimensioni del buffer a cui fa riferimento prgn negli elementi.

[out] pcElem

Tipo: ULONG*

Quando questa funzione restituisce, contiene il conteggio degli elementi LONG 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 se ha esito positivo o un valore di errore in caso contrario.
TYPE_E_BUFFERTOOSMALL	L'origine PROPVARIANT contiene più dei valori crgn. Buffer a cui fa riferimento prgn.
E_INVALIDARG	PropVARIANT non era del tipo appropriato.

Commenti

Questa funzione helper viene usata nelle posizioni in cui l'applicazione chiamante prevede che un PROPVARIANT contenga un vettore di valori LONG con un numero fisso di elementi.

Se l'origine PROPVARIANT ha tipo VT_VECTOR VT_I4VT_ARRAY | oVT_I4 | VT_I4, questa funzione helper estrae fino a valori LONG crgn e li inserisce nel buffer a cui punta da prgn. Se PROPVARIANT contiene più elementi che si adattano al buffer prgn , questa funzione restituisce un errore e imposta pcElem su 0.

Esempio

Nell'esempio seguente, da includere come parte di un programma più ampio, viene illustrato come usare PropVariantToInt32Vector per accedere a un valore vettore Int32 in un PROPVARIANT.

// PROPVARIANT propvar;
// Assume the variable propvar is initialized and valid
LONG rgLongs[4]; // The application is expecting propvar to hold 4 LONGs in a vector
ULONG cElems;
HRESULT hr = PropVariantToInt32Vector(propvar, rgLongs, ARRAYSIZE(rgLongs), &cElems);
if (SUCCEEDED(hr))
{
     if (cElems == ARRAYSIZE(rgLongs))
     {
         // The application got 4 LONGs which are now stored in rgLongs
     }
     else
     {
         // The application got cElems which are stored in the first cElems elements of rgLongs
     }
}

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