Função PropVariantToUInt64WithDefault (propvarutil.h)

Extrai o valor ULONGLONG de uma estrutura PROPVARIANT . Se nenhum valor existir, o valor padrão especificado será retornado.

Sintaxe

PSSTDAPI_(ULONGLONG) PropVariantToUInt64WithDefault(
  [in] REFPROPVARIANT propvarIn,
  [in] ULONGLONG      ullDefault
);

Parâmetros

[in] propvarIn

Tipo: REFPROPVARIANT

Referência a uma estrutura PROPVARIANT de origem .

[in] ullDefault

Tipo: ULONGLONG

Especifica um valor de propriedade padrão, para uso em que nenhum valor existe no momento.

Retornar valor

Tipo: ULONGLONG

Retorna o valor LONGLONG sem sinal extraído ou um padrão.

Comentários

Essa função auxiliar é usada em locais em que o aplicativo de chamada espera que um PROPVARIANT mantenha um valor ULONGLONG e gostaria de usar um valor padrão se não o fizer. Por exemplo, um aplicativo que obtém valores de um repositório de propriedades pode usar isso para extrair com segurança o valor ULONGLONG para propriedades UInt64 .

Se o PROPVARIANT de origem tiver tipo VT_UI8, essa função auxiliar extrairá o valor ULONGLONG . Caso contrário, ele tentará converter o valor na estrutura PROPVARIANT em um ULONGLONG. Se o PROPVARIANT de origem tiver tipo VT_EMPTY ou uma conversão não for possível, PropVariantToUInt64WithDefault retornará o padrão fornecido por ullDefault. Consulte PropVariantChangeType para obter uma lista de conversões possíveis.

Exemplos

O exemplo a seguir, a ser incluído como parte de um programa maior, demonstra como usar PropVariantToUInt64WithDefault para acessar um valor ULONGLONG em um PROPVARIANT.

// IPropertyStore *ppropstore;
// Assume variable ppropstore is initialized and valid
PROPVARIANT propvar = {0};
HRESULT hr = ppropstore->GetValue(PKEY_Size, &propvar);
if (SUCCEEDED(hr))
{
     // PKEY_Size is expected to produce a VT_UI8 or VT_EMPTY value.
     // The application developer decided to treat VT_EMPTY or invalid values as 0
     ULONGLONG ullSize = PropVariantToUInt64WithDefault(propvar, 0);
     // ullSize is now valid.
     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