InitPropVariantFromUInt16 function (propvarutil.h)

Article
02/22/2024

Initializes a PROPVARIANT structure based on a 16-bit unsigned integer value.

Syntax

HRESULT InitPropVariantFromUInt16(
  [in]  USHORT      uiVal,
  [out] PROPVARIANT *ppropvar
);

Parameters

[in] uiVal

Type: USHORT

Source 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_UI2 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 InitPropVariantFromUInt16.

PROPVARIANT propvar;

HRESULT hr = InitPropVariantFromUInt16(5, &propvar);

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

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
Redistributable	Windows Desktop Search (WDS) 3.0