PropVariantToDouble 函数 (propvarutil.h)

从 PROPVARIANT 结构中提取双精度值。

语法

PSSTDAPI PropVariantToDouble(
  [in]  REFPROPVARIANT propvarIn,
  [out] DOUBLE         *pdblRet
);

parameters

[in] propvarIn

类型： REFPROPVARIANT

对源 PROPVARIANT 结构的引用。

[out] pdblRet

类型： DOUBLE*

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

返回值

类型： HRESULT

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

注解

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

如果源 PROPVARIANT 具有 类型VT_R8，则此帮助程序函数将提取双精度值。 否则，它会尝试将 PROPVARIANT 结构中的值转换为 double。 如果无法转换， PropVariantToDouble 将返回失败代码并将 pdblRet 设置为 0.0。 有关可能转换的列表，请参阅 PropVariantChangeType 。 请注意， VT_EMPTY 已成功转换为 0.0。

示例

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

// IPropertyStore *ppropstore;
// Assume variable ppropstore is initialized and valid
PROPVARIANT propvar = {0};
HRESULT hr = ppropstore->GetValue(PKEY_Image_HorizontalResolution, &propvar);
if (SUCCEEDED(hr))
{
     // PKEY_Image_HorizontalResolution is expected to produce a VT_R8 or VT_EMPTY value.
     // PropVariantToDouble will successfully convert VT_EMPTY to a 0.0.
     DOUBLE dblHorzResolution;
     hr = PropVariantToDouble(propvar, &dblHorzResolution);
     if (SUCCEEDED(hr))
     {
        // dblHorzResolution is now valid
     }
     else
     {
        // dblHorzResolution contains 0.0
     }
     PropVariantClear(&propvar);
}

要求

请参阅

InitPropVariantFromDouble

PropVariantGetDoubleElem

PropVariantToDoubleWithDefault

VariantToDouble