InitVariantFromInt16 function (propvarutil.h)

Initializes a VARIANT structure with a 16-bit integer value.

Syntax

HRESULT InitVariantFromInt16(
  [in]  SHORT   iVal,
  [out] VARIANT *pvar
);

Parameters

[in] iVal

Type: SHORT

Source SHORT value.

[out] pvar

Type: VARIANT*

When this function returns, contains the initialized VARIANT structure.

Return value

Type: HRESULT

If this function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

Creates a VT_I2 variant.

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

VARIANT var;

HRESULT hr = InitVariantFromInt16(3, &var);

if (SUCCEEDED(hr))
{
    // var now is valid and has type VT_I2.
    VariantClear(&propvar);
}

Requirements

See also

InitPropVariantFromInt16

VariantToInt16

VariantToInt16WithDefault