VariantToDouble 函数 (propvarutil.h)

VARIANT 结构中提取 DOUBLE 值。 如果无法提取任何值,则分配默认值。

语法

PSSTDAPI VariantToDouble(
  [in]  REFVARIANT varIn,
  [out] DOUBLE     *pdblRet
);

参数

[in] varIn

类型: REFVARIANT

对源 VARIANT 结构的引用。

[out] pdblRet

类型: DOUBLE*

当此函数返回时, 包含提取的值(如果存在);否则为 0.0。

返回值

类型: HRESULT

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

注解

当调用应用程序希望 VARIANT 包含 DOUBLE 值时,使用此帮助程序函数。 例如,从 Shell 文件夹获取值的应用程序可以使用此函数从文件夹的某个属性(其值存储为 DOUBLE)安全地提取值。

如果源 VARIANT 的类型为 VT_R8,则此函数提取 DOUBLE 值。

如果源 VARIANT 的类型不是 VT_R8,则函数会尝试将 VARIANT 结构中存储的值转换为 DOUBLE。 如果无法进行转换, VariantToDouble 将返回失败代码并将 pdblRet 设置为 0.0。 有关可能转换的列表,请参阅 PropVariantChangeType 。 请注意,VT_EMPTY已成功转换为 0.0。

示例

以下示例将作为较大程序的一部分包含,演示如何使用 VariantToDouble 访问存储在 VARIANT 结构中的 DOUBLE 值。

// VARIANT var;
// Assume variable var is initialize and valid.
// The application expects var to hold a VT_R8 value.
DOUBLE dblValue;

HRESULT hr = VariantToDouble(var, & dblValue);

if (SUCCEEDED(hr))
{
    // dblValue is now valid.
}
else
{
    // dblValue 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

另请参阅

InitVariantFromDouble

PropVariantChangeType

PropVariantToDouble

VariantToDoubleArray