Função PropVariantGetBooleanElem (propvarutil.h)
Extrai um único elemento booliano de uma estrutura PROPVARIANT do tipo VT_BOOL
, VT_VECTOR | VT_BOOL
ou VT_ARRAY | VT_BOOL
.
Sintaxe
PSSTDAPI PropVariantGetBooleanElem(
[in] REFPROPVARIANT propvar,
[in] ULONG iElem,
[out] BOOL *pfVal
);
Parâmetros
[in] propvar
Tipo: REFPROPVARIANT
Uma referência à estrutura PROPVARIANT de origem.
[in] iElem
Tipo: ULONG
Especifica o vetor ou índice de matriz; caso contrário, iElem deve ser 0.
[out] pfVal
Tipo: BOOL*
Quando essa função retorna, contém o valor booliano extraído.
Retornar valor
Tipo: HRESULT
Se essa função for bem-sucedida, ela retornará S_OK. Caso contrário, ele retornará um código de erro HRESULT.
Comentários
Se a estrutura PROPVARIANT de origem tiver o tipo VT_BOOL
, iElem deverá ser 0. Caso contrário , iElem deve ser menor que o número de elementos no vetor ou na matriz. Você pode usar PropVariantGetElementCount para obter o número de elementos no vetor ou na matriz.
O exemplo a seguir usa essa função para percorrer os valores em uma estrutura PROPVARIANT .
Exemplos
// 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
}
}
}
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 |