InitVariantFromInt32 function (propvarutil.h)

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

Syntax

HRESULT InitVariantFromInt32(
  [in]  LONG    lVal,
  [out] VARIANT *pvar
);

Parameters

[in] lVal

Type: LONG

Source LONG 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_I4 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 InitVariantFromInt32.

VARIANT var;

HRESULT hr = InitVariantFromInt32(3, &var);

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

Requirements

See also

InitPropVariantFromInt32

VariantToInt32

VariantToInt32WithDefault