共用方式為

StringCchPrintfExW 函式 (strsafe.h)

  • 發行項

將格式化的數據寫入指定的字串。 目的地緩衝區的大小會提供給 函式，以確保它不會寫入超過這個緩衝區的結尾。

StringCchPrintfEx 會傳回目的地字串結尾的指標，以及該字串中保留未使用的字元數，以新增 StringCchPrintf 的功能。 旗標也可以傳遞至 函式以取得其他控制件。

StringCchPrintfEx 是下列函式的取代專案：

語法

STRSAFEAPI StringCchPrintfExW(
  [out]           STRSAFE_LPWSTR  pszDest,
  [in]            size_t          cchDest,
  [out, optional] STRSAFE_LPWSTR  *ppszDestEnd,
  [out, optional] size_t          *pcchRemaining,
  [in]            DWORD           dwFlags,
  [in]            STRSAFE_LPCWSTR pszFormat,
                  ...             
);

參數

[out] pszDest

類型： LPTSTR

目的地緩衝區，接收從 pszFormat 及其自變數建立的格式化 Null 終止字串。

[in] cchDest

類型： size_t

目的地緩衝區的大小，以字元為單位。 此值必須夠大，才能容納最終格式化字串加上 1，以考慮終止 Null 字元。 允許的最大字元數是 STRSAFE_MAX_CCH。

[out, optional] ppszDestEnd

類型： LPTSTR*

pszDest 結尾的指標位址。 如果 ppszDestEnd 不是 NULL ，而且任何數據都複製到目的地緩衝區中，這會指向字串結尾的終止 Null 字元。

[out, optional] pcchRemaining

類型： size_t*

pszDest 中未使用的字元數，包括終止的 Null 字元。 如果 pcchRemaining 為 NULL，則不會保留或傳回計數。

[in] dwFlags

類型： DWORD

下列一或多個值。

值 意義
STRSAFE_FILL_BEHIND_NULL
0x00000200
 如果函式成功， 則會使用 dwFlags 的低位元組 (0) ，在終止 Null 字元之後填滿 pszDest 的未初始化部分。
STRSAFE_IGNORE_NULLS
0x00000100
 將 NULL 字串指標視為空字串， (TEXT (“”) ) 。
STRSAFE_FILL_ON_FAILURE
0x00000400
 如果函式失敗， 則會使用 dwFlags (0) 的低位元組來填滿整個 pszDest 緩衝區，且緩衝區為 null 終止。 如果 發生STRSAFE_E_INSUFFICIENT_BUFFER 失敗，則會覆寫傳回的任何截斷字串。
STRSAFE_NULL_ON_FAILURE
0x00000800
 如果函式失敗， pszDest 會設定為空字串， (TEXT (“”) ) 。 如果 發生STRSAFE_E_INSUFFICIENT_BUFFER 失敗，則會覆寫任何截斷的字串。
STRSAFE_NO_TRUNCATION
0x00001000
 如同 在STRSAFE_NULL_ON_FAILURE的情況下，如果函式失敗， pszDest 會設定為空字串， (TEXT (“”) ) 。 如果 發生STRSAFE_E_INSUFFICIENT_BUFFER 失敗，則會覆寫任何截斷的字串。

[in] pszFormat

類型： LPCTSTR

格式字串。 此字串必須以 Null 結尾。 如需詳細資訊，請參閱 格式規格語法。

...

要插入 pszFormat 字串中的自變數。

傳回值

類型： HRESULT

此函式可以傳回下列其中一個值。 強烈建議您使用 SUCCEEDED 和 FAILED 宏來測試此函式的傳回值。

傳回碼 描述
S_OK
 有足夠的空間可將結果複製到 pszDest 而不截斷，且緩衝區為 Null 終止。
STRSAFE_E_INVALID_PARAMETER
 cchDest 中的值是 0 或大於 STRSAFE_MAX_CCH，或目的地緩衝區已滿。
STRSAFE_E_INSUFFICIENT_BUFFER
 複製作業因為緩衝區空間不足而失敗。 根據 dwFlags 的值，目的地緩衝區可能包含預定結果的截斷、Null 終止版本。 在可接受截斷的情況下，這不一定會被視為失敗狀況。
 

請注意，此函式會傳回 HRESULT 值，不同於它所取代的函式。

備註

相較於取代的函式， StringCchPrintfEx 會提供額外處理，以在程式代碼中處理適當的緩衝區。 在涉及緩衝區溢出的許多安全性問題中，都牽涉到緩衝區處理不佳的情況。 StringCchPrintfEx 一律以 null 終止非零長度的目的地緩衝區。

如果 pszDest、 pszFormat 或任何自變數字串重疊，則行為未定義。

除非指定STRSAFE_IGNORE_NULLS旗標，否則 pszFormat 或 pszDest 都不應該是 NULL，在此情況下，這兩者都可能是 NULL。 不過，即使忽略 NULL 值，仍可能會傳回空間不足的錯誤。

StringCchPrintfEx 可用於其泛型形式或更特定的表單。 字串的數據類型會決定您應該使用的這個函式形式。

String 資料類型 字串常值 函式
char "字串" StringCchPrintfExA
TCHAR TEXT (“string”) StringCchPrintfEx
WCHAR L“string” StringCchPrintfExW
 

注意

strsafe.h 標頭會將 StringCchPrintfEx 定義為別名，根據 UNICODE 預處理器常數的定義，自動選取此函式的 ANSI 或 Unicode 版本。 混合使用編碼中性別名與非編碼中性的程序代碼，可能會導致編譯或運行時間錯誤不符。 如需詳細資訊，請參閱 函式原型的慣例。

規格需求

需求 值
最低支援的用戶端 Windows XP with SP2 [傳統型應用程式 |UWP 應用程式]
最低支援的伺服器 Windows Server 2003 SP1 [傳統型應用程式 |UWP 應用程式]
目標平台 Windows
標頭 strsafe.h

另請參閱

參考

StringCbPrintfEx

StringCchPrintf

StringCchVPrintfEx