StringCchPrintfExA 函数 (strsafe.h)

项目
08/26/2023

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

StringCchPrintfEx 通过返回指向目标字符串末尾的指针以及该字符串中剩余的未使用的字符数，将添加到 StringCchPrintf 的功能中。标志也可以传递给函数，以便进行其他控制。

StringCchPrintfEx 取代了以下函数：

语法

STRSAFEAPI StringCchPrintfExA(
  [out]           STRSAFE_LPSTR  pszDest,
  [in]            size_t         cchDest,
  [out, optional] STRSAFE_LPSTR  *ppszDestEnd,
  [out, optional] size_t         *pcchRemaining,
  [in]            DWORD          dwFlags,
  [in]            STRSAFE_LPCSTR pszFormat,
                  ...            
);

参数

[out] pszDest

类型： LPTSTR

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

[in] cchDest

类型： size_t

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

[out, optional] ppszDestEnd

类型： LPTSTR*

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

[out, optional] pcchRemaining

类型： size_t*

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

[in] dwFlags

类型：DWORD

以下一个或多个值。

值	含义
STRSAFE_FILL_BEHIND_NULL 0x00000200	如果函数成功，将使用 dwFlags (0) 的低字节来填充 pszDest 的未初始化部分，其后为终止 null 字符。
STRSAFE_IGNORE_NULLS 0x00000100	将 NULL 字符串指针视为空字符串 (TEXT (“”) ) 。
STRSAFE_FILL_ON_FAILURE 0x00000400	如果函数失败，将使用 dwFlags (0) 的低字节填充整个 pszDest 缓冲区，缓冲区以 null 结尾。如果 STRSAFE_E_INSUFFICIENT_BUFFER 失败，将覆盖返回的任何截断字符串。
STRSAFE_NULL_ON_FAILURE 0x00000800	如果函数失败， pszDest 将设置为 TEXT (“”) ) (空字符串。如果 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 和 FAILED 宏来测试此函数的返回值。

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

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

注解

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

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

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

StringCchPrintfEx 可以以其泛型形式或更具体的形式使用。字符串的数据类型决定了应使用的此函数的形式。

String 数据类型	字符串	功能
char	“字符串”	StringCchPrintfExA
TCHAR	TEXT (“string”)	StringCchPrintfEx
WCHAR	L“string”	StringCchPrintfExW

注意

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

要求


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

另请参阅

引用

StringCbPrintfEx

StringCchPrintf

StringCchVPrintfEx

通过

StringCchPrintfExA 函数 (strsafe.h)

语法

参数

返回值

注解

要求

另请参阅

反馈

其他资源