VariantToBooleanWithDefault 関数 (propvarutil.h)
VARIANT 構造体から BOOL 値を抽出します。 値が存在しない場合は、指定された既定値が返されます。
構文
PSSTDAPI_(BOOL) VariantToBooleanWithDefault(
[in] REFVARIANT varIn,
[in] BOOL fDefault
);
パラメーター
[in] varIn
型: REFVARIANT
ソース VARIANT 構造体への参照。
[in] fDefault
種類: BOOL
抽出可能な値が存在しない場合に使用する既定値。
戻り値
種類: BOOL
抽出された BOOL 値を返します。それ以外の場合は、 fDefault で指定された既定値。
注釈
このヘルパー関数は、呼び出し元のアプリケーションが BOOL 値を保持するバリアント型 (VARIANT) の値を予期し、それを保持しない場合は既定値を使用する必要がある場合に使用されます。
ソース VARIANT が VT_BOOL 型の場合、このヘルパーは BOOL 値を抽出します。
ソース VARIANT がVT_BOOL型でない場合、関数は VARIANT の値を BOOL に変換しようとします。
ソース VARIANT がVT_EMPTY型の場合、または変換できない場合、 VariantToBooleanWithDefault はfDefault によって提供される既定値を返します。 可能な変換の一覧については、「 PropVariantChangeType 」を参照してください。
例
大規模なプログラムの一部として含める次の例では、VariantToBooleanWithDefault を使用して、VARIANT 構造体に格納されている BOOL 値にアクセスする方法を示します。
// VARIANT var;
// Assume variable var is initialized and valid.
// The application expects var to hold a BOOL value.
// The application treats VT_EMPTY as FALSE.
BOOL fValue = VariantToBooleanWithDefault(var, FALSE);
// fValue is now valid.
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | WINDOWS XP と SP2、Windows Vista [デスクトップ アプリのみ] |
| サポートされている最小のサーバー | Windows Server 2003 SP1 [デスクトップ アプリのみ] |
| 対象プラットフォーム | Windows |
| ヘッダー | propvarutil.h |
| Library | Propsys.lib |
| [DLL] | Propsys.dll (バージョン 6.0 以降) |
| 再頒布可能パッケージ | Windows デスクトップ検索 (WDS) 3.0 |