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 字元。 |
|
psz 中的值為 NULL、cbMax 大於 STRSAFE_MAX_CCH * sizeof(TCHAR) ,或 psz 大於 cbMax。
|
請注意,此函式會傳回 HRESULT 值,不同於它所取代的函式。
備註
相較於所取代的函式, StringCbLength 是額外的工具,可讓您在程式代碼中處理適當的緩衝區。 在涉及緩衝區溢出的許多安全性問題中,都牽涉到緩衝區處理不佳的情況。
StringCbLength 可以用於其泛型形式或更特定的表單中。 字串的數據類型會決定您應該使用的這個函式形式。
String 資料類型 | 字串常值 | 函式 |
---|---|---|
char | "字串" | StringCbLengthA |
TCHAR | TEXT (“string”) | StringCbLength |
WCHAR | L“string” | StringCbLengthW |
UnalignedStringCbLength 是此函式的別名。
注意
strsafe.h 標頭會將 StringCbLength 定義為別名,根據 UNICODE 預處理器常數的定義,自動選取此函式的 ANSI 或 Unicode 版本。 混合使用編碼中性別名與非編碼中性的程序代碼,可能會導致編譯或運行時間錯誤不符。 如需詳細資訊,請參閱 函式原型的慣例。
規格需求
需求 | 值 |
---|---|
最低支援的用戶端 | Windows XP with SP2 [傳統型應用程式 |UWP 應用程式] |
最低支援的伺服器 | Windows Server 2003 SP1 [傳統型應用程式 |UWP 應用程式] |
目標平台 | Windows |
標頭 | strsafe.h |