StringCbPrintfA 函数 （strsafe.h）

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

StringCbPrintf 替代以下函数：

语法

STRSAFEAPI StringCbPrintfA(
  [out] STRSAFE_LPSTR  pszDest,
  [in]  size_t         cbDest,
  [in]  STRSAFE_LPCSTR pszFormat,
        ...            
);

参数

[out] pszDest

类型：LPSTR

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

[in] cbDest

类型：size_t

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

[in] pszFormat

类型：LPCSTR

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

...

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

返回值

类型：HRESULT

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

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

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

言论

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

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

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

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

字符串数据类型 字符串文本 功能
char “string” StringCbPrintfA
TCHAR TEXT（“string”） StringCbPrintf
WCHAR L“string” StringCbPrintfW
 

例子

以下示例演示了使用四个参数 StringCbPrintf的基本用法。

int const arraysize = 30;
TCHAR pszDest[arraysize]; 
size_t cbDest = arraysize * sizeof(TCHAR);

LPCTSTR pszFormat = TEXT("%s %d + %d = %d.");
TCHAR* pszTxt = TEXT("The answer is");

HRESULT hr = StringCbPrintf(pszDest, cbDest, pszFormat, pszTxt, 1, 2, 3);

// The resultant string at pszDest is "The answer is 1 + 2 = 3."

注意

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

要求

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

另请参阅

参考

StringCbPrintfEx

StringCbVPrintf

StringCchPrintf

  • Last updated on