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

緩衝區的指標，在輸入時包含要串連 pszSrc 的 Null 終止字串。 在輸出中，這是包含整個結果字串的目的地緩衝區。 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：

  • 如果同時指定STRSAFE_FILL_ON_FAILURE，STRSAFE_NO_TRUNCATION據以填入目的地緩衝區。
  • 否則，目的地緩衝區將會未經修改。

傳回值

函式會傳回下表所列的其中一個NTSTATUS值。 如需如何測試 NTSTATUS 值的資訊，請參閱 使用 NTSTATUS 值。

傳回碼 Description
STATUS_SUCCESS 此 成功 狀態表示源數據已存在、字串完全串連而不截斷，且結果目的地緩衝區為 Null 終止。
STATUS_BUFFER_OVERFLOW 這個 警告 狀態表示複製作業因目的地緩衝區空間不足而未完成。 如果 已設定STRSAFE_NO_TRUNCATION ，請參閱 dwFlags 參數以取得詳細資訊。
STATUS_INVALID_PARAMETER

此錯誤狀態表示函式收到無效的輸入參數。 如需詳細資訊，請參閱下列段落。

當下列情況時，函式會傳回 STATUS_INVALID_PARAMETER ：

  • 指定了無效的旗標。
  • cbDest 中的值大於緩衝區大小上限。
  • 目的地緩衝區已滿。
  • NULL 指標不存在STRSAFE_IGNORE_NULLS旗標。
  • 目的地緩衝區指標為 NULL，但緩衝區大小不是零。
  • 目的地緩衝區指標為 NULL，或其長度為零，但存在非零長度來源字串。

備註

應該使用 RtlStringCbCatExW 和 RtlStringCbCatExA ，而不是下列函式：

  • strcat
  • wcscat

因為 RtlStringCbCatExW 和 RtlStringCbCatExA 收到目的地緩衝區的大小做為輸入，所以不會寫入緩衝區結尾。

RtlStringCbCatEx 藉由傳回目的地字串結尾的指標，以及該字串中剩餘未使用的位元組數目，以新增至 RtlStringCbCat 的功能。 旗標也可以傳遞至 函式以取得其他控制件。

使用 RtlStringCbCatExW 來處理 Unicode 字串和 RtlStringCbCatExA 來處理 ANSI 字串。 要使用的表單是由您的數據所決定，如下表所示。

字串資料類型 字串常值 函式
WCHAR L“string” RtlStringCbCatExW
char "字串" RtlStringCbCatExA

如果 pszSrc 和 pszDest 指向重疊字串，則函式的行為是未定義的。

除非已設定 STRSAFE_IGNORE_NULLS 旗標，否則 pszSrc 或 pszDest 都不能是 NULL ，在此情況下，或兩者都可以是 NULL。 如果 pszDest 為 NULL，pszSrc 必須是 NULL 或指向空字串。

如需安全字串函式的詳細資訊，請參閱 使用安全字串函式。

規格需求

需求 值
最低支援的用戶端 Windows XP 中提供 Service Pack 1 (SP1) 和更新版本的 Windows。
目標平台 桌面
標頭 ntstrsafe.h (包含 Ntstrsafe.h)
程式庫 Ntstrsafe.lib
IRQL 如果正在操作的字串一律位於記憶體中，則為任何 ，否則PASSIVE_LEVEL

另請參閱