Funzione PropVariantToBooleanVectorAlloc (propvarutil.h)

Articolo
08/25/2023

Estrae i dati da una struttura PROPVARIANT in un vettore booleano appena allocato.

Sintassi

PSSTDAPI PropVariantToBooleanVectorAlloc(
  [in]  REFPROPVARIANT propvar,
  [out] BOOL           **pprgf,
  [out] ULONG          *pcElem
);

Parametri

[in] propvar

Tipo: REFPROPVARIANT

Riferimento a una struttura PROPVARIANT di origine.

[out] pprgf

Tipo: BOOL**

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

[out] pcElem

Tipo: ULONG*

Quando termina, questa funzione contiene il conteggio degli elementi booleani 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 valore di vettore booleano.

Se l'origine PROPVARIANT ha tipo VT_VECTOR | VT_BOOL o VT_ARRAY | VT_BOOL, questa funzione estrae un vettore di valori booleani in un vettore appena allocato di valori BOOL . L'applicazione chiamante è responsabile dell'uso di CoTaskMemFree per rilasciare il vettore a cui punta pprgf quando non è più necessario.

Esempio

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

// PROPVARIANT propvar;
// Assume the variable propvar is initialized and valid. The application is 
// expecting propvar to contain a vector of Boolean values.
BOOL *prgFlags;
ULONG cFlags;
HRESULT hr = PropVariantToBooleanVectorAlloc(propvar, &prgFlags, &cFlags);

if (SUCCEEDED(hr))
{
     // The prgFlags variable now points to a vector that contains a count
     // of cFlags flags.
     CoTaskMemFree(prgFlags);
}

Requisiti


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