PropVariantToInt16WithDefault function (propvarutil.h)

Article
02/22/2024

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

Syntax

PSSTDAPI_(SHORT) PropVariantToInt16WithDefault(
  [in] REFPROPVARIANT propvarIn,
  [in] SHORT          iDefault
);

Parameters

[in] propvarIn

Type: REFPROPVARIANT

Reference to a source PROPVARIANT structure.

[in] iDefault

Type: SHORT

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

Return value

Type: SHORT

Returns the extracted short value, or default.

Remarks

This helper function is used in places where the calling application expects a PROPVARIANT to hold an Int16 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 SHORT value for Int16 properties.

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

Requirements

Requirement	Value
Minimum supported client	Windows XP with SP2, Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2003 with SP1 [desktop apps only]
Target Platform	Windows
Header	propvarutil.h
Library	Propsys.lib
DLL	Propsys.dll (version 6.0 or later)
Redistributable	Windows Desktop Search (WDS) 3.0