InitPropVariantFromUInt32 function

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

Syntax


HRESULT InitPropVariantFromUInt32(
  _In_  ULONG       ulVal,
  _Out_ PROPVARIANT *ppropvar
);

Parameters

ulVal [in]

Type: ULONG

Source ULONG 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_UI4 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 InitPropVariantFromUInt32.


PROPVARIANT propvar;

HRESULT hr = InitPropVariantFromUInt32(56, &propvar);

if (SUCCEEDED(hr))
{
    // propvar now is valid and has type VT_UI4.
    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

DLL

Propsys.dll (version 6.0 or later)

See also

PropVariantToUInt32
PropVariantToUInt32WithDefault
InitVariantFromUInt32

 

 

Show: