variantToBoolean 函数 (propvarutil.h)
从 VARIANT 结构中提取布尔属性的值。 如果无法提取任何值，则分配默认值。
语法
PSSTDAPI VariantToBoolean(
[in] REFVARIANT varIn,
[out] BOOL *pfRet
);
参数
[in] varIn
类型： REFVARIANT
对源 VARIANT 结构的引用。
[out] pfRet
类型： BOOL*
当此函数返回时，包含提取的值（如果存在）;否则为 FALSE。
返回值
类型： HRESULT
如果此函数成功，则返回 S_OK。 否则，将返回 HRESULT 错误代码。
注解
当调用应用程序需要 VARIANT 保存布尔值时，使用此帮助程序函数。 例如，从 Shell 文件夹获取值的应用程序可以使用此函数从文件夹的布尔属性之一安全地提取值。
如果源 VARIANT 的类型为 VT_BOOL，则此函数提取 BOOL 值。
如果源 VARIANT 的类型不是 VT_BOOL，此函数将尝试将 VARIANT 结构中的值转换为 BOOL。 如果无法转换， VariantToBoolean 将返回失败代码并将 pfRet 设置为 FALSE。 有关可能转换的列表，请参阅 PropVariantChangeType 。 请注意，VT_EMPTY已成功转换为 FALSE。
示例
以下示例将作为较大程序的一部分包含在内，演示如何使用 VariantToBoolean 访问 VARIANT 中的 BOOL 值。
// VARIANT var;
// Assume variable var is initialize and valid.
// The application expects it to hold a VT_BOOL value.
BOOL fValue;
HRESULT hr = VariantToBoolean(var, &fValue);
if (SUCCEEDED(hr))
{
// fValue is now valid.
}
else
{
// fValue is always FALSE.
}
要求
| 要求 | 值 |
|---|---|
| 最低受支持的客户端 | Windows XP SP2、Windows Vista [仅限桌面应用] |
| 最低受支持的服务器 | Windows Server 2003 SP1 [仅限桌面应用] |
| 目标平台 | Windows |
| 标头 | propvarutil.h |
| Library | Propsys.lib |
| DLL | Propsys.dll (6.0 或更高版本) |
| 可再发行组件 | Windows 桌面搜索 (WDS) 3.0 |