RtlStringCbCatExA 函式 (ntstrsafe.h)
RtlStringCbCatExW 和 RtlStringCbCatExA 函式會串連兩個字節計數的字串。
語法
NTSTRSAFEDDI RtlStringCbCatExA(
[in, out, optional] NTSTRSAFE_PSTR pszDest,
[in] size_t cbDest,
[in, optional] NTSTRSAFE_PCSTR pszSrc,
[out, optional] NTSTRSAFE_PSTR *ppszDestEnd,
[out, optional] size_t *pcbRemaining,
[in] DWORD dwFlags
);
參數
[in, out, optional] pszDest
緩衝區的指標,在輸入時會包含以 null 結尾的字串,pszSrc 將會串連。 在輸出中,這是包含整個結果字串的目的地緩衝區。 pszSrc 的字串會新增至 pszDest 的字串結尾,並以 null 字元終止。 pszDest 指標可以 NULL,但只有在 dwFlags中設定STRSAFE_IGNORE_NULLS時。
[in] cbDest
目的地緩衝區的大小,以位元組為單位。 緩衝區必須夠大,才能同時包含字串和終止的 Null 字元。
針對 Unicode 字串,位元組數目上限為 NTSTRSAFE_MAX_CCH * sizeof(WCHAR)
針對 ANSI 字串,最大位元組數目為 NTSTRSAFE_MAX_CCH * sizeof(char)
[in, optional] pszSrc
Null 終止字串的指標。 此字串會串連至緩衝區中包含在 pszDest 之字串的結尾。 pszSrc 指標可以 NULL,但只有在 dwFlags中設定STRSAFE_IGNORE_NULLS時。
[out, optional] ppszDestEnd
如果呼叫端提供非NULL 位址指標,則在串連作業完成之後,函式會載入該位址,並具有目的地緩衝區產生的 NULL 字元串終止符。
[out, optional] pcbRemaining
如果呼叫端提供非NULL 位址指標,函式會載入位址,其中包含 pszDest所指向之緩衝區中未使用的位元組數目,包括用於終止 Null 字元的位元組。
[in] dwFlags
一或多個旗標,並選擇性地填滿位元組。 旗標的定義如下:
價值 | 意義 |
---|---|
STRSAFE_FILL_BEHIND_NULL | 如果設定此旗標且函式成功,則會使用 dwFlags 的低位元組來填滿結尾 Null 字元後面的目的地緩衝區部分。 |
STRSAFE_IGNORE_NULLS | 如果設定此旗標,pszDest 或 pszSrc或兩者都可以 NULL。 NULLpszSrc 指標會被視為可以複製的空字串(TEXT(“”)。 nullpszDest 指標無法接收空字串。 |
STRSAFE_FILL_ON_FAILURE | 如果設定此旗標且函式失敗,則會使用 dwFlags 的低位元組來填滿整個目的地緩衝區,而緩衝區會以 null 結束。 此作業會覆寫任何預先存在的緩衝區內容。 |
STRSAFE_NULL_ON_FAILURE | 如果設定此旗標且函式失敗,目的地緩衝區會設定為空字串 (TEXT(“”))。 此作業會覆寫任何預先存在的緩衝區內容。 |
STRSAFE_NO_TRUNCATION |
如果已設定此旗標,且函式會傳回 STATUS_BUFFER_OVERFLOW:
|
傳回值
此函式會傳回下表所列的其中一個NTSTATUS值。 如需如何測試 NTSTATUS 值的資訊,請參閱使用 NTSTATUS 值
傳回碼 | 描述 |
---|---|
STATUS_SUCCESS | 此 成功 狀態表示源數據存在、字串完全串連而不截斷,而結果目的地緩衝區會以 Null 結束。 |
STATUS_BUFFER_OVERFLOW | 此 警告 狀態表示複製作業因目的地緩衝區空間不足而未完成。 如果已設定 STRSAFE_NO_TRUNCATION,請參閱 dwFlags 參數以取得詳細資訊。 |
STATUS_INVALID_PARAMETER |
這個 錯誤 狀態表示函式收到無效的輸入參數。 如需詳細資訊,請參閱下列段落。 函式會在下列情況下傳回 STATUS_INVALID_PARAMETER:
|
言論
應使用 RtlStringCbCatExW 和 RtlStringCbCatExA,而不是下列函式:
- strcat
- wcscat
由於 RtlStringCbCatExW 和 RtlStringCbCatExA接收目的地緩衝區的大小作為輸入,因此它們不會寫入緩衝區結尾。
RtlStringCbCatEx 會傳回目的地字串結尾的指標,以及該字串中未使用的位元組數目,以新增至 RtlStringCbCat 的功能。 旗標也可以傳遞至 函式以取得其他控制件。
使用 RtlStringCbCatExW 來處理 Unicode 字串,並 RtlStringCbCatExA 來處理 ANSI 字符串。 要使用的表單是由您的數據決定,如下表所示。
字串數據類型 | 字串常值 | 功能 |
---|---|---|
WCHAR | L“string” | RtlStringCbCatExW |
char | “string” | RtlStringCbCatExA |
如果 pszSrc 和 pszDest 指向重迭字串,則函式的行為是未定義的。
pszSrc 或 pszDest 都不能 NULL,除非設定STRSAFE_IGNORE_NULLS旗標,在此情況下或兩者都可以 NULL。 如果 pszDestNULL,pszSrc 必須 NULL 或指向空字串。
要求
要求 | 價值 |
---|---|
最低支援的用戶端 | Windows XP 中提供 Service Pack 1 (SP1) 和更新版本的 Windows。 |
目標平臺 | 桌面 |
標頭 | ntstrsafe.h (包括 Ntstrsafe.h) |
連結庫 | Ntstrsafe.lib |
IRQL | 如果所操作的字串一律位於記憶體中,則為任何 ,否則PASSIVE_LEVEL |