Funzione PropVariantGetBooleanElem (propvarutil.h)

Articolo
03/05/2024

Estrae un singolo elemento booleano da una struttura PROPVARIANT di tipo VT_BOOL, VT_VECTOR | VT_BOOLo VT_ARRAY | VT_BOOL.

Sintassi

PSSTDAPI PropVariantGetBooleanElem(
  [in]  REFPROPVARIANT propvar,
  [in]  ULONG          iElem,
  [out] BOOL           *pfVal
);

Parametri

[in] propvar

Tipo: REFPROPVARIANT

Riferimento alla struttura PROPVARIANT di origine.

[in] iElem

Tipo: ULONG

Specifica il vettore o l'indice della matrice; in caso contrario, iElem deve essere 0.

[out] pfVal

Tipo: BOOL*

Quando questa funzione restituisce, contiene il valore booleano estratto.

Valore restituito

Tipo: HRESULT

Se questa funzione ha esito positivo, restituisce S_OK. In caso contrario, restituisce un codice di errore HRESULT .

Commenti

Se la struttura PROPVARIANT di origine ha tipo VT_BOOL, iElem deve essere 0. In caso contrario , iElem deve essere minore del numero di elementi nel vettore o nella matrice. È possibile usare PropVariantGetElementCount per ottenere il numero di elementi nel vettore o nella matrice.

Nell'esempio seguente viene usata questa funzione per eseguire il ciclo dei valori in una struttura PROPVARIANT .

Esempio

// PROPVARIANT propvar;
// assume propvar is initialized and valid

if ((propvar.vt & VT_TYPEMASK) == VT_BOOL)
{
    UINT cElem = PropVariantGetElementCount(propvar);
    HRESULT hr = <mark type="const">S_OK</mark>;
    
    for (UINT iElem = 0; SUCCEEDED(hr) && iElem < cElem; iElem ++)
    {
        BOOL fValue;
        hr = PropVariantGetBooleanElem(propvar, iElem, &fValue);
    
        if (SUCCEEDED(hr))
        {
            // fValue is valid now
        }
    }
}

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

Vedi anche

PropVariantGetElem

Condividi tramite