Expand Minimize

VariantGetStringElem function

Extracts a single wide string element from a variant structure.

Syntax


HRESULT VariantGetStringElem(
  _In_   REFVARIANT var,
  _In_   ULONG iElem,
  _Out_  PWSTR *ppszVal
);

Parameters

var [in]

Type: REFVARIANT

Reference to a source variant structure.

iElem [in]

Type: ULONG

Specifies a vector or array index; otherwise, value must be 0.

ppszVal [out]

Type: PWSTR*

The address of a pointer to the extracted element value.

Return value

Type: HRESULT

If this function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

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

Library

Propsys.lib

DLL

Propsys.dll (version 6.0 or later)

 

 

Community Additions

ADD
Show:
© 2014 Microsoft