通过

StringCbCopyNA 函数 (strsafe.h)

  • 项目

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

StringCbCopyN 取代了以下函数：

语法

STRSAFEAPI StringCbCopyNA(
  [out] STRSAFE_LPSTR  pszDest,
  [in]  size_t         cbDest,
  [in]  STRSAFE_PCNZCH pszSrc,
  [in]  size_t         cbToCopy
);

参数

[out] pszDest

类型： LPTSTR

接收复制字符的目标缓冲区。

[in] cbDest

类型： size_t

pszDest 的大小（以字节为单位）。 此值必须足够大，以容纳复制的字节 (pszSrc 的大小或 cbSrc 的值，以较小的) 为准，同时考虑终止 null 字符。 允许的最大字符数为 STRSAFE_MAX_CCH * sizeof(TCHAR)。

[in] pszSrc

类型： LPCTSTR

源字符串。 此字符串必须以 null 结尾。

[in] cbToCopy

类型： size_t

要从 pszSrc 复制到 pszDest 的最大字节数。

返回值

类型： HRESULT

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

返回代码 说明
S_OK
 存在源数据，从 pszSrc 复制数据而不截断，结果目标缓冲区以 null 结尾。
STRSAFE_E_INVALID_PARAMETER
 cbDest 中的值大于 STRSAFE_MAX_CCH * sizeof(TCHAR)，或者目标缓冲区已满。
STRSAFE_E_INSUFFICIENT_BUFFER
 由于缓冲区空间不足，复制操作失败。 目标缓冲区包含预期结果的截断、以 null 结尾的版本。 在截断是可接受的情况下，这不一定被视为失败条件。
 

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

注解

StringCbCopyN 提供额外的处理，以便在代码中正确处理缓冲区。 不良的缓冲区处理与许多涉及缓冲区溢出的安全问题有关。 StringCbCopyN 始终为 null 终止，并且永远不会溢出有效的目标缓冲区，即使源字符串的内容在操作期间发生更改也是如此。

虽然此例程旨在替代 strncpy，但在行为上存在差异。 如果 cbSrc 大于 pszSrc 中的字节数，则 StringCbCopyN（与 strncpy 不同）在复制 cbSrc 字节之前不会继续使用 pszDest 填充 null 字符。

如果 pszSrc 和 pszDest 指向的字符串重叠，则行为未定义。

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

StringCbCopyN 可用于其泛型形式或更具体的形式。 字符串的数据类型决定了应使用的此函数的形式，如下表所示。

String 数据类型 字符串 函数
char “字符串” StringCbCopyNA
TCHAR TEXT (“string”) StringCbCopyN
WCHAR L“string” StringCbCopyNW
 

注意

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

要求

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

另请参阅

引用

StringCbCopy

StringCbCopyNEx

StringCchCopyN