Função PropVariantToInt16WithDefault (propvarutil.h)

Extrai o valor da propriedade Int16 de uma estrutura PROPVARIANT . Se nenhum valor existir no momento, o valor padrão especificado será retornado.

Sintaxe

PSSTDAPI_(SHORT) PropVariantToInt16WithDefault(
  [in] REFPROPVARIANT propvarIn,
  [in] SHORT          iDefault
);

Parâmetros

[in] propvarIn

Tipo: REFPROPVARIANT

Referência a uma estrutura PROPVARIANT de origem .

[in] iDefault

Tipo: SHORT

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

Retornar valor

Tipo: SHORT

Retorna o valor curto 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 Int16 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 usá-lo para extrair com segurança o valor SHORT para propriedades Int16 .

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

Requisitos

Confira também

InitPropVariantFromInt16

PropVariantChangeType

PropVariantToInt16

VariantToInt16