StringCbPrintf_lA 函数 (strsafe.h)
将格式化的数据写入指定的字符串。 向函数提供目标缓冲区的大小,以确保它不会写入此缓冲区的末尾。
StringCbPrintf_l 类似于 StringCbPrintf ,但包含区域设置信息的参数。
语法
STRSAFEAPI StringCbPrintf_lA(
[out] STRSAFE_LPSTR pszDest,
[in] size_t cbDest,
[in] _Printf_format_string_params_(2)STRSAFE_LPCSTR pszFormat,
[in] _locale_t locale,
...
);
参数
[out] pszDest
目标缓冲区,接收从 pszFormat 及其参数创建的格式化的以 null 结尾的字符串。
[in] cbDest
目标缓冲区的大小(以字节为单位)。 此值必须足够大,以便容纳最终格式化字符串以及终止 null 字符。 允许的最大字节数为 STRSAFE_MAX_CCH * sizeof(TCHAR)
。
[in] pszFormat
格式字符串。 此字符串必须以 null 结尾。 有关详细信息,请参阅 格式规范语法。
[in] locale
区域设置对象。 有关详细信息,请参阅 _create_locale。
...
要插入到 pszFormat 字符串中的参数。
返回值
此函数可以返回以下值之一。 强烈建议使用 SUCCEEDED 和 FAILED 宏来测试此函数的返回值。
返回代码 | 说明 |
---|---|
|
有足够的空间将结果复制到 pszDest 而不截断,并且缓冲区以 null 结尾。 |
|
cbDest 中的值是 0 或大于 STRSAFE_MAX_CCH * sizeof(TCHAR) 。
|
|
由于缓冲区空间不足,复制操作失败。 目标缓冲区包含截断的、以 null 结尾的预期结果版本。 在可以接受截断的情况下,这可能不一定被视为故障条件。 |
注解
如果 pszDest、 pszFormat 或任何参数字符串指向的字符串重叠,则行为未定义。
pszFormat 和 pszDest 都不应为 NULL。 如果需要处理 null 字符串指针值,请参阅 StringCbPrintf_lEx 。
若要使用此函数,必须先在头文件中定义以下宏,然后才能包含 StrSafe.h。
#define STRSAFE_LOCALE_FUNCTIONS
注意
strsafe.h 标头将StringCbPrintf_l定义为别名,该别名根据 UNICODE 预处理器常量的定义自动选择此函数的 ANSI 或 Unicode 版本。 将非特定编码别名与非非特定编码的代码混合使用可能会导致不匹配,从而导致编译或运行时错误。 有关详细信息,请参阅 函数原型的约定。
要求
要求 | 值 |
---|---|
最低受支持的客户端 | Windows Vista [桌面应用 | UWP 应用] |
最低受支持的服务器 | Windows Server 2008 [桌面应用 | UWP 应用] |
目标平台 | Windows |
标头 | strsafe.h |