通过

StringCbPrintfExA 函数 （strsafe.h）

  • 项目

将数据写入指定的字符串。 目标缓冲区的大小提供给函数，以确保它不会写入到此缓冲区的末尾。

StringCbPrintfEx 通过返回指向目标字符串末尾的指针以及该字符串中未使用的字节数来添加 StringCbPrintf 的功能。 还可以将标志传递给函数以获取其他控件。

StringCbPrintfEx 替代以下函数：

语法

STRSAFEAPI StringCbPrintfExA(
  [out]           STRSAFE_LPSTR  pszDest,
  [in]            size_t         cbDest,
  [out, optional] STRSAFE_LPSTR  *ppszDestEnd,
  [out, optional] size_t         *pcbRemaining,
  [in]            DWORD          dwFlags,
  [in]            STRSAFE_LPCSTR pszFormat,
                  ...            
);

参数

[out] pszDest

类型：LPTSTR

目标缓冲区，接收从 pszFormat 及其参数创建的格式化的、以 null 结尾的字符串。

[in] cbDest

类型：size_t

目标缓冲区的大小（以字节为单位）。 此值必须足够大，以适应最终格式化字符串加上终止 null 字符。 允许的最大字节数是 STRSAFE_MAX_CCH * sizeof(TCHAR)。

[out, optional] ppszDestEnd

类型：LPTSTR*

指向 pszDest末尾的指针的地址。 如果 ppszDestEnd 为非NULL，并且任何数据都复制到目标缓冲区中，则指向字符串末尾的终止 null 字符。

[out, optional] pcbRemaining

类型：size_t*

pszDest中未使用的字节数，包括用于终止 null 字符的字节数。 如果 NULL，则不会保留或返回计数。

[in] dwFlags

类型：DWORD

以下一个或多个值。

价值 意义
STRSAFE_FILL_BEHIND_NULL
0x00000200
 如果函数成功，则 dwFlags （0） 的低字节用于在终止 null 字符之后填充 pszDest 的未初始化部分。
STRSAFE_IGNORE_NULLS
0x00000100
 将 NULL 字符串指针（如空字符串（“”）处理）。
STRSAFE_FILL_ON_FAILURE
0x00000400
 如果函数失败，则 dwFlags （0） 的低字节用于填充整个 pszDest 缓冲区，缓冲区以 null 结尾。 如果发生 STRSAFE_E_INSUFFICIENT_BUFFER 失败，将覆盖返回的任何截断字符串。
STRSAFE_NULL_ON_FAILURE
0x00000800
 如果函数失败，pszDest 设置为空字符串（“”）。 如果发生 STRSAFE_E_INSUFFICIENT_BUFFER 失败，将覆盖任何截断的字符串。
STRSAFE_NO_TRUNCATION
0x00001000
 与 STRSAFE_NULL_ON_FAILURE一样，如果函数失败，pszDest 设置为空字符串（TEXT（“”））。 如果发生 STRSAFE_E_INSUFFICIENT_BUFFER 失败，将覆盖任何截断的字符串。

[in] pszFormat

类型：LPCTSTR

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

...

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

返回值

类型：HRESULT

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

返回代码 描述
S_OK
 没有足够的空间将结果复制到 pszDest 而不截断，并且缓冲区以 null 结尾。
STRSAFE_E_INVALID_PARAMETER
 cbDest 中的值是 0 或大于 STRSAFE_MAX_CCH * sizeof(TCHAR)，或者目标缓冲区已满。
STRSAFE_E_INSUFFICIENT_BUFFER
 复制操作由于缓冲区空间不足而失败。 根据 dwFlags的值，目标缓冲区可能包含被截断的、以 null 结尾的预期结果版本。 在截断是可接受的情况下，这不一定被视为失败条件。
 

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

言论

与它替换的函数相比，StringCbPrintfEx 为代码中的正确缓冲区处理提供其他处理。 缓冲区处理不当与涉及缓冲区溢出的许多安全问题有关。 StringCbPrintfEx 始终以 null 结尾的非零长度目标缓冲区。

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

除非指定 STRSAFE_IGNORE_NULLS 标志，否则 pszFormat 或 pszDest 都不应 NULL，在这种情况下，两者都可能 NULL。 但是，即使忽略了 NULL 值 ，由于空间不足而导致的错误仍可能会返回。

StringCbPrintfEx 可用于其泛型形式或更具体的窗体。 字符串的数据类型确定应使用的此函数的形式。

字符串数据类型 字符串文本 功能
char “string” StringCbPrintfExA
TCHAR TEXT（“string”） StringCbPrintfEx
WCHAR L“string” StringCbPrintfExW
 

注意

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

要求

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

另请参阅

参考

StringCbVPrintfEx

StringCchPrintf

StringCchPrintfEx