InitPropVariantFromDouble function (propvarutil.h)

Initializes a PROPVARIANT structure based on a specified double value.

Syntax

HRESULT InitPropVariantFromDouble(
  [in]  DOUBLE      dblVal,
  [out] PROPVARIANT *ppropvar
);

Parameters

[in] dblVal

Type: DOUBLE

The source double value.

[out] ppropvar

Type: PROPVARIANT*

When this function returns, contains the initialized PROPVARIANT 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 propvariant.

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 InitPropVariantFromDouble.

PROPVARIANT propvar;

HRESULT hr = InitPropVariantFromDouble(3.1415, &propvar);

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

Requirements

See also

InitPropVariantFromDoubleVector

InitVariantFromDouble

PropVariantToDouble

PropVariantToDoubleWithDefault