Função PropVariantToUInt32 (propvarutil.h)
Extrai um valor ULONG de uma estrutura PROPVARIANT . Se nenhum valor puder ser extraído, um valor padrão será atribuído.
Sintaxe
PSSTDAPI PropVariantToUInt32(
[in] REFPROPVARIANT propvarIn,
[out] ULONG *pulRet
);
Parâmetros
[in] propvarIn
Tipo: REFPROPVARIANT
Uma referência a uma estrutura PROPVARIANT de origem .
[out] pulRet
Tipo: ULONG*
Quando essa função retorna, contém o valor da propriedade extraída, se houver; caso contrário, 0.
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
Essa função auxiliar é usada em locais onde o aplicativo de chamada espera que um PROPVARIANT mantenha um valor ULONG . Por exemplo, um aplicativo que obtém valores de um repositório de propriedades pode usá-lo para extrair com segurança o valor ULONG para propriedades UInt32.
Se o PROPVARIANT de origem tiver o tipo VT_UI4, essa função auxiliar extrairá o valor ULONG . Caso contrário, ele tentará converter o valor na estrutura PROPVARIANT em um ULONG. Se uma conversão não for possível, PropVariantToUInt32 retornará um código de falha e definirá pulRet como 0. Consulte PropVariantChangeType para obter uma lista de conversões possíveis. Observe que VT_EMPTY é convertido com êxito em 0.
Exemplos
O exemplo a seguir, a ser incluído como parte de um programa maior, demonstra como usar PropVariantToUInt32 para acessar um valor ULONG em um PROPVARIANT.
// IPropertyStore *ppropstore;
// Assume variable ppropstore is initialized and valid
PROPVARIANT propvar = {0};
HRESULT hr = ppropstore->GetValue(PKEY_Rating, &propvar);
if (SUCCEEDED(hr))
{
// PKEY_Rating is expected to produce a VT_UI4 or VT_EMPTY value.
// PropVariantToUInt32 will convert VT_EMPTY to 0.
ULONG uRating;
hr = PropVariantToUInt32(propvar, &uRating);
if (SUCCEEDED(hr))
{
// uRating is now valid
}
else
{
// uRating is always 0
}
PropVariantClear(&propvar);
}
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 |