InitPropVariantFromBuffer function (propvarutil.h)

Article
10/13/2021

Initializes a PROPVARIANT structure using the contents of a buffer.

Syntax

PSSTDAPI InitPropVariantFromBuffer(
  [in]  const void  *pv,
  [in]  UINT        cb,
  [out] PROPVARIANT *ppropvar
);

Parameters

[in] pv

Type: const void*

Pointer to the buffer.

[in] cb

Type: UINT

The length of the buffer, in bytes.

[out] ppropvar

Type: PROPVARIANT*

When this function returns, contains the initialized PROPVARIANT structure.

Return value

Type: HRESULT

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

Remarks

Creates a VT_VECTOR | VT_UI1 propvariant.

Examples

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

// 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.
PROPVARIANT propvar;

HRESULT hr = InitPropVariantFromBuffer(pv, cb, &propvar);

if (SUCCEEDED(hr))
{
    // propvar now is valid and has type VT_VECTOR | VT_UI1.
 
    PropVariantClear(&propvar);
}

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