通过

StringCchLengthA 函数 (strsafe.h)

  • 项目

确定字符串是否超过指定的长度（以字符为单位）。

StringCchLength 取代了以下函数：

语法

STRSAFEAPI StringCchLengthA(
  [in]  STRSAFE_PCNZCH psz,
  [in]  size_t         cchMax,
  [out] size_t         *pcchLength
);

参数

[in] psz

类型： LPCTSTR

要检查其长度的字符串。

[in] cchMax

类型： size_t

psz 中允许的最大字符数，包括终止 null 字符。 此值不能超过 STRSAFE_MAX_CCH。

[out] pcchLength

类型： size_t*

psz 中的字符数，不包括终止 null 字符。 仅当 pcch 不为 NULL 且函数成功时，此值才有效。

返回值

类型： HRESULT

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

返回代码 说明
S_OK
 psz 处的字符串不是 NULL，字符串的长度 (包括终止 null 字符) 小于或等于 cchMax 字符。
STRSAFE_E_INVALID_PARAMETER
 psz 中的值为 NULL，cchMax 大于 STRSAFE_MAX_CCH，或 psz 大于 cchMax。
 

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

注解

与它替换的函数相比， StringCchLength 是用于在代码中正确处理缓冲区的附加工具。 不良的缓冲区处理与许多涉及缓冲区溢出的安全问题有关。

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

String 数据类型 字符串 函数
char “字符串” StringCchLengthA
TCHAR TEXT (“string”) StringCchLength
WCHAR L“string” StringCchLengthW
 

UnalignedStringCchLength 是此函数的别名。

注意

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

要求

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

另请参阅

StringCbLength