StringCchVPrintf_lA 函数 (strsafe.h)

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

StringCchVPrintf_l 类似于 StringCchVPrintf ,但包含区域设置信息的参数。

语法

STRSAFEAPI StringCchVPrintf_lA(
  [out] STRSAFE_LPSTR                                  pszDest,
  [in]  size_t                                         cchDest,
  [in]  _Printf_format_string_params_(2)STRSAFE_LPCSTR pszFormat,
  [in]  _locale_t                                      locale,
  [in]  va_list                                        argList
);

参数

[out] pszDest

目标缓冲区,接收从 pszFormatargList 创建的格式化的以 null 结尾的字符串。

[in] cchDest

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

[in] pszFormat

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

[in] locale

区域设置对象。 有关详细信息,请参阅 _create_locale

[in] argList

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

返回值

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

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

注解

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

如果 pszDestpszFormat 或任何参数字符串指向的字符串重叠,则行为未定义。

pszFormatpszDest 都不应为 NULL。 如果需要处理 null 字符串指针值,请参阅 StringCchVPrintf_lEx

若要使用此函数,必须在头文件中定义以下宏,然后才能包含 StrSafe.h。

#define STRSAFE_LOCALE_FUNCTIONS

注意

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

要求

要求
最低受支持的客户端 Windows Vista [桌面应用 | UWP 应用]
最低受支持的服务器 Windows Server 2008 [桌面应用 | UWP 应用]
目标平台 Windows
标头 strsafe.h