通过

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，并 失败 宏来测试此函数的返回值。

返回代码 描述
S_OK
 psz 处的字符串未 NULL，字符串（包括终止 null 字符）的长度小于或等于 cbMax 字符。
STRSAFE_E_INVALID_PARAMETER
 psz 中的值 NULL，cbMax 大于 ，或者 psz 长于 cbMax。
 

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

言论

与其替换的函数相比，StringCbLength 是一个用于在代码中正确处理缓冲区的其他工具。 缓冲区处理不当与涉及缓冲区溢出的许多安全问题有关。

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

字符串数据类型 字符串文本 功能
char “string” StringCbLengthA
TCHAR TEXT（“string”） StringCbLength
WCHAR L“string” StringCbLengthW
 

UnalignedStringCbLength 是此函数的别名。

注意

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

要求

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

另请参阅

StringCchLength