VariantToDoubleWithDefault 関数 (propvarutil.h)

VARIANT 構造体から DOUBLE 値を抽出します。 値が存在しない場合は、指定された既定値が返されます。

構文

PSSTDAPI_(DOUBLE) VariantToDoubleWithDefault(
  [in] REFVARIANT varIn,
  [in] DOUBLE     dblDefault
);

パラメーター

[in] varIn

型: REFVARIANT

ソース VARIANT 構造体への参照。

[in] dblDefault

型: DOUBLE

抽出可能な値が存在しない場合に使用する既定値。

戻り値

型: DOUBLE

抽出された double 値を返します。それ以外の場合は、 dblDefault で指定された既定値。

注釈

このヘルパー関数は、呼び出し元のアプリケーションが DOUBLE 値を保持する VARIANT を予期し、それを持たない場合は既定値を使用する場合に使用されます。

ソース VARIANT が VT_R8 型の場合、このヘルパーは DOUBLE 値を抽出します。

ソース VARIANT が VT_R8 型でない場合、関数は VARIANT の値を DOUBLE に変換しようとします。

ソース VARIANT がVT_EMPTY型の場合、または変換できない場合、 VariantToDoubleWithDefault はdblDefault によって提供される既定値を返します。 可能な変換の一覧については、「 PropVariantChangeType 」を参照してください。

例

大規模なプログラムの一部として含める次の例では、VariantToDoubleWithDefault を使用して VARIANT 構造体に格納されている DOUBLE 値にアクセスする方法を示します。

// VARIANT var;
// Assume variable var is initialized and valid.
// The application expects var to hold a DOUBLE value.

// The application wants to treat VT_EMPTY as 3.1415.
DOUBLE dblValue = VariantToDoubleWithDefault(var, 3.1415);

// dblValue is now valid.

要件

こちらもご覧ください

InitVariantFromDouble

PropVariantChangeType

PropVariantToDouble

VariantToDouble