PropVariantToBoolean 函数 (propvarutil.h)

  • 项目

提取 PROPVARIANT 结构的布尔属性值。 如果无法提取任何值，则分配默认值。

语法

PSSTDAPI PropVariantToBoolean(
  [in]  REFPROPVARIANT propvarIn,
  [out] BOOL           *pfRet
);

参数

[in] propvarIn

类型： REFPROPVARIANT

对源 PROPVARIANT 结构的引用。

[out] pfRet

类型： BOOL*

当此函数返回时，包含提取的属性值（如果存在）;否则，包含 FALSE。

返回值

类型： HRESULT

如果此函数成功，则返回 S_OK。 否则，将返回 HRESULT 错误代码。

注解

此帮助程序函数用于调用应用程序要求 PROPVARIANT 保存布尔值的位置。 例如，从属性存储区获取值的应用程序可以使用它安全地提取布尔属性的布尔值。

如果源 PROPVARIANT 的类型 VT_BOOL，则此帮助程序函数将提取布尔值。 否则，它会尝试将 PROPVARIANT 结构中的值转换为布尔值。 如果无法转换， PropVariantToBoolean 将返回失败代码并将 pfRet 设置为 FALSE。 有关可能转换的列表，请参阅 PropVariantChangeType 。 请注意， VT_EMPTY 已成功转换为 FALSE。

示例

以下示例将作为更大的程序的一部分包含，演示如何使用 PropVariantToBoolean 访问 PROPVARIANT 中的布尔值。

// IPropertyStore *ppropstore;
// Assume variable ppropstore is initialized and valid
PROPVARIANT propvar = {0};

HRESULT hr = ppropstore->GetValue(PKEY_IsShared, &propvar);
if (SUCCEEDED(hr))
{
     // PKEY_IsShared is expected to produce a VT_BOOL or VT_EMPTY value.
     // PropVariantToBoolean will convert VT_EMPTY to FALSE.
     BOOL fShared;
     
     hr = PropVariantToBoolean(propvar, &fShared);
     if (SUCCEEDED(hr))
     {
         // fShared is now valid
     }
     else
     {
         // fShared is always FALSE
     }
     
     PropVariantClear(&propvar);
}

要求

要求 值
最低受支持的客户端 Windows XP SP2、Windows Vista [仅限桌面应用]
最低受支持的服务器 Windows Server 2003 SP1 [仅限桌面应用]
目标平台 Windows
标头 propvarutil.h
Library Propsys.lib
DLL Propsys.dll (6.0 或更高版本)
可再发行组件 Windows 桌面搜索 (WDS) 3.0

另请参阅

InitPropVariantFromBoolean

PropVariantGetBooleanElem

PropVariantToBooleanWithDefault

VariantToBoolean