通过

StringCchCopyNExW 函数 (strsafe.h)

  • 项目

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

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

StringCchCopyNEx 取代了以下函数：

语法

STRSAFEAPI StringCchCopyNExW(
  [out]           STRSAFE_LPWSTR  pszDest,
  [in]            size_t          cchDest,
  [in]            STRSAFE_PCNZWCH pszSrc,
  [in]            size_t          cchToCopy,
  [out, optional] STRSAFE_LPWSTR  *ppszDestEnd,
  [out, optional] size_t          *pcchRemaining,
  [in]            DWORD           dwFlags
);

参数

[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 的最大字符数。

[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 失败，将覆盖任何截断的字符串。

返回值

类型： HRESULT

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

返回代码 说明
S_OK
 源数据已存在，完全复制且未截断，生成的目标缓冲区以 null 结尾。
STRSAFE_E_INVALID_PARAMETER
 pszDest 或 pszSrc 大于 STRSAFE_MAX_CCH，如果存在要复制的源数据，或者传递了无效标志，则 pszDest 为 NULL。
STRSAFE_E_INSUFFICIENT_BUFFER
 由于缓冲区空间不足，复制操作失败。 根据 dwFlags 的值，目标缓冲区可能包含预期结果的截断、以 null 结尾的版本。 在截断是可接受的情况下，这不一定被视为失败条件。
 

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

注解

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

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

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

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

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

String 数据类型 字符串 函数
char “字符串” StringCchCopyNExA
TCHAR TEXT (“string”) StringCchCopyNEx
WCHAR L“string” StringCchCopyNExW
 

注意

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

要求

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

另请参阅

引用

StringCbCopyNEx

StringCchCopyN