InitVariantFromGUIDAsBuffer function (propvarutil.h)

Article
02/22/2024

Initializes a VARIANT structure based on a GUID. The structure is initialized as VT_ARRAY | VT_UI1.

Syntax

HRESULT InitVariantFromGUIDAsBuffer(
  [in]  REFGUID guid,
  [out] VARIANT *pvar
);

Parameters

[in] guid

Type: REFGUID

Reference to the source GUID.

[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

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 InitVariantFromGUIDAsBuffer.

VARIANT var;

HRESULT hr = InitVariantFromGUIDAsBuffer(FMTID_DocSummaryInformation, &var);

if (SUCCEEDED(hr))
{
    // var now is valid and has type VT_ARRAY | VT_UI1.
    VariantClear(&var);
}

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