VariantToBooleanWithDefault 函数 (propvarutil.h)
从 VARIANT 结构中提取 BOOL 值。 如果不存在值，则返回指定的默认值。
语法
PSSTDAPI_(BOOL) VariantToBooleanWithDefault(
[in] REFVARIANT varIn,
[in] BOOL fDefault
);
参数
[in] varIn
类型： REFVARIANT
对源 VARIANT 结构的引用。
[in] fDefault
类型： BOOL
在不存在可提取值的情况下使用的默认值。
返回值
类型： BOOL
返回提取的 BOOL 值;否则为 fDefault 中指定的默认值。
注解
当调用应用程序要求 VARIANT 保存 BOOL 值并且希望使用默认值（如果不是）时，将使用此帮助程序函数。
如果源 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 |