InitVariantFromBuffer function

Initializes a VARIANT structure with the contents of a buffer.

Syntax

HRESULT InitVariantFromBuffer(
  _In_  const VOID    *pv,
  _In_        UINT    cb,
  _Out_       VARIANT *pvar
);

Parameters

pv [in]

Type: const VOID*

Pointer to the source buffer.

cb [in]

Type: UINT

The length of the buffer, in bytes.

pvar [out]

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

See also

VariantToBuffer

InitPropVariantFromBuffer