StringCchVPrintfA 函数 (strsafe.h)

  • 项目

使用指向参数列表的指针将格式化数据写入指定字符串。 目标缓冲区的大小提供给函数，以确保它不会写入此缓冲区的末尾。

StringCchVPrintf 取代了以下函数：

语法

STRSAFEAPI StringCchVPrintfA(
  [out] STRSAFE_LPSTR  pszDest,
  [in]  size_t         cchDest,
  [in]  STRSAFE_LPCSTR pszFormat,
  [in]  va_list        argList
);

参数

[out] pszDest

类型： LPTSTR

目标缓冲区，接收从 pszFormat 和 argList 创建的格式化的以 null 结尾的字符串。

[in] cchDest

类型： size_t

目标缓冲区的大小（以字符为单位）。 此值必须足够大，才能容纳最终格式化字符串加 1，以解释终止 null 字符。 允许的最大字符数是 STRSAFE_MAX_CCH。

[in] pszFormat

类型： LPCTSTR

格式字符串。 此字符串必须以 null 结尾。 有关详细信息，请参阅 格式规范语法。

[in] argList

类型： va_list

要插入 到 pszFormat 字符串中的参数。

返回值

类型： HRESULT

此函数可以返回以下值之一。 强烈建议使用 SUCCEEDED 和 FAILED 宏来测试此函数的返回值。

返回代码 说明
S_OK
 有足够的空间用于在不截断的情况下将结果复制到 pszDest ，并且缓冲区以 null 结尾。
STRSAFE_E_INVALID_PARAMETER
 cchDest 中的值为 0 或大于 STRSAFE_MAX_CCH。
STRSAFE_E_INSUFFICIENT_BUFFER
 由于缓冲区空间不足，复制操作失败。 目标缓冲区包含预期结果的截断、以 null 结尾的版本。 在截断是可接受的情况下，这不一定被视为失败条件。
 

请注意，此函数返回 HRESULT 值，这与它所替换的函数不同。

注解

StringCchVPrintf 提供额外的处理，以便在代码中正确处理缓冲区。 不良的缓冲区处理与许多涉及缓冲区溢出的安全问题有关。 StringCchVPrintf 始终为 null 终止非零长度的目标缓冲区。

有关va_lists的详细信息，请参阅 Stdarg.h 中定义的约定。

如果 pszDest、 pszFormat 或任何参数字符串指向的字符串重叠，则行为未定义。

pszFormat 和 pszDest 都不应为 NULL。 如果需要处理 null 字符串指针值，请参阅 StringCchVPrintfEx 。

StringCchVPrintf 可用于其泛型形式或更具体的形式。 字符串的数据类型决定了应使用的此函数的形式，如下表所示。

String 数据类型 字符串 函数
char “字符串” StringCchVPrintfA
TCHAR TEXT (“string”) StringCchVPrintf
WCHAR L“string” StringCchVPrintfW
 

注意

strsafe.h 标头将 StringCchVPrintf 定义为别名，该别名根据 UNICODE 预处理器常量的定义自动选择此函数的 ANSI 或 Unicode 版本。 将非特定编码别名的使用与非非特定编码的代码混合使用可能会导致不匹配，从而导致编译或运行时错误。 有关详细信息，请参阅 函数原型的约定。

要求

要求 值
最低受支持的客户端 具有 SP2 的 Windows XP [桌面应用 |UWP 应用]
最低受支持的服务器 Windows Server 2003 SP1 [桌面应用 |UWP 应用]
目标平台 Windows
标头 strsafe.h

另请参阅

引用

StringCbVPrintf

StringCchPrintf

StringCchVPrintfEx