Expand Minimize

InitVariantFromUInt16 function

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

Syntax


HRESULT InitVariantFromUInt16(
  _In_   USHORT uiVal,
  _Out_  VARIANT *pvar
);

Parameters

uiVal [in]

Type: USHORT

Source USHORT value.

pvar [out]

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_UI2 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 InitVariantFromUInt16.


VARIANT var;

HRESULT hr = InitVariantFromUInt16(3, &var);

if (SUCCEEDED(hr))
{
    // var now is valid and has type VT_UI2.
    VariantClear(&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

VariantToUInt16
VariantToUInt16WithDefault
InitPropVariantFromUInt16

 

 

Community Additions

ADD
Show:
© 2014 Microsoft