InitVariantFromGUIDAsString function (propvarutil.h)

Article
02/22/2024

Initializes a VARIANT structure based on a GUID. The structure is initialized as a VT_BSTR type.

Syntax

PSSTDAPI InitVariantFromGUIDAsString(
  [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

Creates a VT_BSTR variant, formatting the GUID in a form similar to {c200e360-38c5-11ce-ae62-08002b2b79ef}.

Examples

The following example, to be included as part of a larger program, demonstrates how to use InitVariantFromGUIDAsString.

VARIANT var;

HRESULT hr = InitVariantFromGUIDAsString(FMTID_DocSummaryInformation, &var);

if (SUCCEEDED(hr))
{
    // var now is valid and has type VT_BSTR.
    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
Library	Propsys.lib
DLL	Propsys.dll (version 6.0 or later)
Redistributable	Windows Desktop Search (WDS) 3.0