InitPropVariantFromBuffer function

Initializes a PROPVARIANT structure using the contents of a buffer.

Syntax

HRESULT InitPropVariantFromBuffer(
  _In_  const void        *pv,
  _In_        UINT        cb,
  _Out_       PROPVARIANT *ppropvar
);

Parameters

pv [in]

Type: const void*

Pointer to the buffer.

cb [in]

Type: UINT

The length of the buffer, in bytes.

ppropvar [out]

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

See also

PropVariantToBuffer

InitVariantFromBuffer