Função PropVariantToUInt16WithDefault (propvarutil.h)
Extrai um valor curto sem sinal de uma estrutura PROPVARIANT . Se nenhum valor existir, o valor padrão especificado será retornado.
Sintaxe
PSSTDAPI_(USHORT) PropVariantToUInt16WithDefault(
[in] REFPROPVARIANT propvarIn,
[in] USHORT uiDefault
);
Parâmetros
[in] propvarIn
Tipo: REFPROPVARIANT
Referência a uma estrutura PROPVARIANT de origem .
[in] uiDefault
Tipo: USHORT
Especifica um valor de propriedade padrão, para uso em que nenhum valor existe no momento.
Retornar valor
Tipo: curto sem sinal
Retorna o valor curto não assinado extraído ou o padrão.
Comentários
Essa função auxiliar é usada em locais em que o aplicativo de chamada espera que um PROPVARIANT mantenha um valor curto sem sinal . Por exemplo, um aplicativo que obtém valores de um repositório de propriedades pode usá-lo para extrair com segurança o valor curto sem sinal para propriedades UInt16.
Se o PROPVARIANT de origem tiver o tipo VT_UI2, essa função auxiliar extrairá o valor curto sem sinal . Caso contrário, ele tentará converter o valor na estrutura PROPVARIANT em um curto sem sinal. Se uma conversão não for possível, PropVariantToUInt16 retornará um código de falha e definirá puiRet 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 PropVariantToUInt16 para acessar um valor curto sem sinal em um PROPVARIANT.
// IPropertyStore *ppropstore;
// Assume variable ppropstore is initialized and valid
PROPVARIANT propvar = {0};
HRESULT hr = ppropstore->GetValue(PKEY_FlagColor, &propvar);
if (SUCCEEDED(hr))
{
// PKEY_FlagColor is expected to produce a VT_UI2 or VT_EMPTY value.
// PropVariantToInt32 will convert VT_EMPTY to 0.
USHORT uColor;
hr = PropVariantToUInt32(propvar, & uColor);
if (SUCCEEDED(hr))
{
// uColor is now valid
}
else
{
// uColor 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 |