InitPropVariantFromInt32 function

Initializes a PROPVARIANT structure based on a 32-bit integer value.

Syntax


HRESULT InitPropVariantFromInt32(
  _In_  LONG        lVal,
  _Out_ PROPVARIANT *ppropvar
);

Parameters

lVal [in]

Type: LONG

The source LONG value.

ppropvar [out]

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_I4 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 InitPropVariantFromInt32.


PROPVARIANT propvar;

HRESULT hr = InitPropVariantFromInt32(127, &propvar);

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

Requirements

Minimum supported client

Windows XP with SP2, Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2003 with SP1 [desktop apps only]

Redistributable

Windows Desktop Search (WDS) 3.0

Header

Propvarutil.h

See also

PropVariantToInt32
PropVariantToInt32WithDefault
InitVariantFromInt32

 

 

Show: