通过

PropVariantToBooleanWithDefault 函数 (propvarutil.h)

  • 项目

提取 PROPVARIANT 结构的布尔属性值。 如果不存在值，则返回指定的默认值。

语法

PSSTDAPI_(BOOL) PropVariantToBooleanWithDefault(
  [in] REFPROPVARIANT propvarIn,
  [in] BOOL           fDefault
);

参数

[in] propvarIn

类型： REFPROPVARIANT

对源 PROPVARIANT 结构的引用。

[in] fDefault

类型： BOOL

指定默认属性值，以便在当前不存在任何值的情况下使用。

返回值

类型： BOOL

提取的布尔值或默认值。

注解

此帮助程序函数用于调用应用程序要求 PROPVARIANT 保存布尔值并且希望使用默认值（如果不是） 的位置。 例如，从属性存储区获取值的应用程序可以使用它安全地提取布尔属性的布尔值。

如果源 PROPVARIANT 的类型 VT_BOOL，则此帮助程序函数将提取布尔值。 否则，它会尝试将 PROPVARIANT 结构中的值转换为布尔值。 如果源 PROPVARIANT 具有 类型VT_EMPTY 或无法进行转换，则 PropVariantToBooleanWithDefault 将返回 fDefault 提供的默认值。 有关可能转换的列表，请参阅 PropVariantChangeType 。

示例

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

// IPropertyStore *ppropstore;
// Assume the variable ppropstore is initialized and valid.
PROPVARIANT propvar = {0};
HRESULT hr = ppropstore->GetValue(PKEY_IsRead, &propvar);

if (SUCCEEDED(hr))
{
     // PKEY_IsRead is expected to produce a VT_BOOL or VT_EMPTY value.
     // The application developer decided to treat VT_EMPTY or invalid values as TRUE
     BOOL fShared = PropVariantToBooleanWithDefault(propvar, TRUE);
     
     // fShared is now valid.
     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