InitVariantFromUInt32 function (propvarutil.h)

Article
02/22/2024

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

Syntax

HRESULT InitVariantFromUInt32(
  [in]  ULONG   ulVal,
  [out] VARIANT *pvar
);

Parameters

[in] ulVal

Type: ULONG

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

VARIANT var;

HRESULT hr = InitVariantFromUInt32(3, &var);

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

Requirements

Requirement	Value
Minimum supported client	Windows XP with SP2, Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2003 with SP1 [desktop apps only]
Target Platform	Windows
Header	propvarutil.h
Redistributable	Windows Desktop Search (WDS) 3.0