InitVariantFromBoolean 函数 (propvarutil.h)

使用布尔值初始化 VARIANT 结构。

语法

HRESULT InitVariantFromBoolean(
  [in]  BOOL    fVal,
  [out] VARIANT *pvar
);

参数

[in] fVal

类型: BOOL

BOOL 值。

[out] pvar

类型: VARIANT*

当此函数返回时,包含初始化的 VARIANT 结构。

返回值

类型: HRESULT

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

注解

创建VT_BOOL变体。

请注意,此函数初始化的 boolVal 结构 成员的类型VARIANT_BOOL ,因此可以具有 VARIANT_TRUEVARIANT_FALSE值。 直接使用此结构成员时,请使用这些常量而不是 TRUEFALSE ,因为 VARIANT_TRUE 不等于 TRUE ,并且大小 (VARIANT_TRUE) 与 size of (TRUE) 不同。

这是一个内联函数,其源代码在 标头中提供。 它不包含在任何 .dll 或 .lib 文件中。

示例

以下示例将作为较大程序的一部分包含,演示如何使用 InitVariantFromBoolean

VARIANT var;

HRESULT hr = InitVariantFromBoolean(TRUE, &var);

if (SUCCEEDED(hr))
{
    // var now is valid and has type VT_BOOL.
     VariantClear(&propvar);
}

要求

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

另请参阅

InitPropVariantFromBoolean

VariantToBoolean

VariantToBooleanWithDefault