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 巨集來測試此函式的傳回值。
傳回碼 | 描述 |
---|---|
|
psz 的字串未 NULL,而且字串長度(包括終止 null 字元)小於或等於 cbMax 字元。 |
|
|
請注意,此函式會傳回 HRESULT 值,與它所取代的函式不同。
言論
與其取代的函式相比,StringCbLength 是程式代碼中適當緩衝區處理的額外工具。 不良的緩衝區處理牽涉到涉及緩衝區滿溢的許多安全性問題。
StringCbLength 可用於其泛型表單或更特定的表單中。 字串的數據類型會決定您應該使用的這個函式形式。
字串數據類型 | 字串常值 | 功能 |
---|---|---|
char | “string” | StringCbLengthA |
TCHAR | TEXT(“string”) | StringCbLength |
WCHAR | L“string” | StringCbLengthW |
UnalignedStringCbLength 是此函式的別名。
注意
strsafe.h 標頭會根據 UNICODE 預處理器常數的定義,將 StringCbLength 定義為自動選取此函式的 ANSI 或 Unicode 版本。 混合使用編碼中性別名與非編碼中性的程序代碼,可能會導致編譯或運行時間錯誤不符。 如需詳細資訊,請參閱函式原型的
要求
要求 | 價值 |
---|---|
最低支援的用戶端 | Windows XP with SP2 [傳統型應用程式 |UWP 應用程式] |
支援的最低伺服器 | Windows Server 2003 SP1 [傳統型應用程式 |UWP 應用程式] |
目標平臺 | 窗戶 |
標頭 | strsafe.h |