InitVariantFromBuffer function (propvarutil.h)

Article
02/22/2024

Initializes a VARIANT structure with the contents of a buffer.

Syntax

PSSTDAPI InitVariantFromBuffer(
  [in]  const void *pv,
  [in]  UINT       cb,
  [out] VARIANT    *pvar
);

Parameters

[in] pv

Type: const VOID*

Pointer to the source buffer.

[in] cb

Type: UINT

The length of the buffer, in bytes.

[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_ARRAY | VT_UI1 variant..

Examples

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

// void *pv;
// UINT cb;
// Assume variable pv and cb are initialized and valid. pv points to a 
// buffer and cb contains the size of the buffer in bytes.
VARIANT var;

HRESULT hr = InitVariantFromBuffer(pv, cb, & 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
Library	Propsys.lib
DLL	Propsys.dll (version 6.0 or later)
Redistributable	Windows Desktop Search (WDS) 3.0