通过

VariantToBuffer 函数 (propvarutil.h)

  • 项目

提取存储在类型为 VT_ARRRAY 的 VARIANT 结构中的缓冲区的内容 |VT_UI1。

语法

PSSTDAPI VariantToBuffer(
  [in]  REFVARIANT varIn,
  [out] void       *pv,
  [in]  UINT       cb
);

参数

[in] varIn

类型： REFVARIANT

对源 VARIANT 结构的引用。

[out] pv

类型： VOID*

指向长度 为 cb 字节的缓冲区的指针。 当此函数返回时，包含提取的缓冲区值的第一 个 cb 字节。

[in] cb

类型： UINT

pv 缓冲区的大小（以字节为单位）。 缓冲区的大小应与要提取的数据相同，或者更小。

返回值

类型： HRESULT

返回以下值之一：

返回代码 说明
S_OK
 已成功提取数据。
E_INVALIDARG
 VARIANT 的类型不是 VT_ARRRAY |VT_UI1。
E_FAIL
 VARIANT 缓冲区值的字节数少于 cb 字节。

注解

当调用应用程序要求 VARIANT 保存缓冲区值时，使用此函数。 调用应用程序在调用此函数之前，应检查该值具有预期的长度。

如果源 VARIANT 的类型为 VT_ARRAY |VT_UI1，此函数从 结构中提取第一 个 cb 字节，并将其放置在 pv 指向的缓冲区中。

如果存储的值少于 cb 字节，则 VariantToBuffer 将失败，并且缓冲区未修改。

如果值包含的字节数超过 cb 字节，则 VariantToBuffer 会成功并截断该值。

示例

以下示例将作为较大程序的一部分包含，演示如何使用 VariantToBuffer 访问已存储在 VARIANT 中的结构。

// VARIANT var;
// Assume variable var is initialized and valid. 
// The application expects var to hold a WIN32_FIND_DATAW structure 
// with sizeof(WIN32_FIND_DATAW) bytes.

HRESULT hr = E_UNEXPECTED;

// Verify that the value length is acceptable before you call VariantToBuffer.
if (VariantGetElementCount(var) == sizeof(WIN32_FIND_DATAW))
{
    WIN32_FIND_DATAW wfd;

    hr = VariantToBuffer(var, &wfd, sizeof(wfd));

    if (SUCCEEDED(hr))
    {
        // wfd is now initialized.
    }
}

要求

要求 值
最低受支持的客户端 Windows XP SP2、Windows Vista [仅限桌面应用]
最低受支持的服务器 Windows Server 2003 SP1 [仅限桌面应用]
目标平台 Windows
标头 propvarutil.h
Library Propsys.lib
DLL Propsys.dll (版本 6.0 或更高版本)
可再发行组件 Windows 桌面搜索 (WDS) 3.0

另请参阅

InitVariantFromBuffer

PropVariantToBuffer