stringCbLengthA 函数 (strsafe.h)

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

StringCbLength 是以下函数的替代项：

语法

STRSAFEAPI StringCbLengthA(
  [in]  STRSAFE_PCNZCH psz,
  [in]  size_t         cbMax,
  [out] size_t         *pcbLength
);

[in] psz

类型： LPCTSTR

要检查其长度的字符串。

[in] cbMax

类型： size_t

psz 中允许的最大字节数，包括用于终止 null 字符的字节数。此值不能超过 STRSAFE_MAX_CCH * sizeof(TCHAR)。

[out] pcbLength

类型： size_t*

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

类型： HRESULT

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

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

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

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

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

UnalignedStringCbLength 是此函数的别名。

注意

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