Expand Minimize

PropVariantToDoubleWithDefault function

Extracts a double property value of a PROPVARIANT structure. If no value exists, then the specified default value is returned.

Syntax


DOUBLE PropVariantToDoubleWithDefault(
  _In_  REFPROPVARIANT propvarIn,
  _In_  DOUBLE dblDefault
);

Parameters

propvarIn [in]

Type: REFPROPVARIANT

Reference to a source PROPVARIANT structure.

dblDefault [in]

Type: DOUBLE

Specifies default property value, for use where no value currently exists.

Return value

Type: DOUBLE

Returns extracted double value, or default.

Remarks

This helper function is used in places where the calling application expects a PROPVARIANT to hold a double value and would like to use a default value if it does not. For instance, an application obtaining values from a property store can use this to safely extract the double value for double properties.

If the source PROPVARIANT has type VT_R8, this helper function extracts the double value. Otherwise, it attempts to convert the value in the PROPVARIANT structure into a double. If the source PROPVARIANT has type VT_EMPTY or a conversion is not possible, then PropVariantToDoubleWithDefault will return the default provided by dblDefault. See PropVariantChangeType for a list of possible conversions.

Examples


// 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.
     // The application developer decided to treat VT_EMPTY or invalid values as 72.0
     DOUBLE dblResolution = PropVariantToDoubleWithDefault(propvar, 72.0);
     // dblResolution is now valid.
     PropVariantClear(&propvar);
}

Requirements

Minimum supported client

Windows XP with SP2, Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2003 with SP1 [desktop apps only]

Redistributable

Windows Desktop Search (WDS) 3.0

Header

Propvarutil.h

Library

Propsys.lib

DLL

Propsys.dll (version 6.0 or later)

See also

InitPropVariantFromDouble
PropVariantToDoubleVector
VariantToDouble
PropVariantChangeType

 

 

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.