stringCchCopyNA 函数 (strsafe.h)

  • 项目

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

StringCchCopyN 是以下函数的替代项：

语法

STRSAFEAPI StringCchCopyNA(
  [out] STRSAFE_LPSTR  pszDest,
  [in]  size_t         cchDest,
  [in]  STRSAFE_PCNZCH pszSrc,
  [in]  size_t         cchToCopy
);

参数

[out] pszDest

类型： LPTSTR

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

[in] cchDest

类型： size_t

pszDest 的大小（以字符为单位）。 此值必须足够大，以保存复制的字符 (pszSrc 的长度或 cchSrc 的值，以较小的) 加 1 来解释终止 null 字符。 允许的最大字符数是 STRSAFE_MAX_CCH。

[in] pszSrc

类型： LPCTSTR

源字符串。 此字符串必须最多可读 cchSrc 字符或 null 终止符，以先出现者为准。

[in] cchToCopy

类型： size_t

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

返回值

类型： HRESULT

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

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

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

注解

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

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

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

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

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

String 数据类型 字符串 功能
char “字符串” StringCchCopyNA
TCHAR TEXT (“string”) StringCchCopyN
WCHAR L“string” StringCchCopyNW
 

注意

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

要求

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

另请参阅

引用

StringCbCopyN

StringCchCopy

StringCchCopyNEx