InitVariantFromDouble function (propvarutil.h)

Initializes a VARIANT structure with a value of type DOUBLE.

Syntax

HRESULT InitVariantFromDouble(
  [in]  DOUBLE  dblVal,
  [out] VARIANT *pvar
);

Parameters

[in] dblVal

Type: DOUBLE

Source value.

[out] pvar

Type: VARIANT*

When this function returns, contains the initialized VARIANT structure.

Return value

Type: HRESULT

If this function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

Creates a VT_R8 variant.

This is an inline function, with its source code provided in the header. It is not included in any .dll or .lib file.

Examples

The following example, to be included as part of a larger program, demonstrates how to use InitVariantFromDouble.

VARIANT var;

HRESULT hr = InitVariantFromDouble(3.1415, &var);

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

Requirements

See also

InitPropVariantFromDouble

VariantToDouble

VariantToDoubleWithDefault