InitPropVariantFromUInt16 function (propvarutil.h)

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

See also

InitVariantFromUInt16

PropVariantToUInt16

PropVariantToUInt16WithDefault