stringCchPrintfW 函式 (strsafe.h)
將格式化的數據寫入指定的字串。 目的地緩衝區的大小會提供給 函式，以確保其不會寫入超過這個緩衝區的結尾。
StringCchPrintf 是下列函式的取代專案：
語法
STRSAFEAPI StringCchPrintfW(
[out] STRSAFE_LPWSTR pszDest,
[in] size_t cchDest,
[in] STRSAFE_LPCWSTR pszFormat,
...
);
參數
[out] pszDest
類型： LPTSTR
目的地緩衝區，接收從 pszFormat 及其自變數建立的格式化 Null 終止字串。
[in] cchDest
類型： size_t
目的地緩衝區的大小，以字元為單位。 這個值必須夠大，才能容納最終格式化字串加上 1，以考慮終止的 Null 字元。 允許的最大字元數是 STRSAFE_MAX_CCH。
[in] pszFormat
類型： LPCTSTR
格式字串。 此字串必須以 Null 結束。 如需詳細資訊，請參閱 格式規格語法。
...
要插入 pszFormat 字串中的自變數。
傳回值
類型： HRESULT
此函式可以傳回下列其中一個值。 強烈建議您使用 SUCCEEDED 和 FAILED 宏來測試此函式的傳回值。
| 傳回碼 | 描述 |
|---|---|
|
有足夠的空間可將結果複製到 pszDest 而不截斷，而且緩衝區會以 Null 結束。 |
|
cchDest 中的值是 0 或大於 STRSAFE_MAX_CCH。 |
|
複製作業因為緩衝區空間不足而失敗。 目的地緩衝區包含已截斷且以 Null 終止之預期結果的版本。 在可接受截斷的情況下，這可能不一定被視為失敗狀況。 |
請注意，此函式會傳回 HRESULT 值，與它所取代的函式不同。
備註
相較於所取代的函式， StringCchPrintf 會提供額外的處理，以在程式代碼中正確處理緩衝區。 在涉及緩衝區溢出的許多安全性問題中，緩衝區處理不佳。 StringCchPrintf 一律會以 null 終止非零長度的目的地緩衝區。
如果 pszDest、 pszFormat 或任何自變數字串所指向的字串重疊，則行為是未定義的。
pszFormat 或 pszDest 都不應該是 NULL。 如果您需要處理 Null 字串指標值，請參閱 StringCchPrintfEx 。
StringCchPrintf 可用於其泛型形式或更特定的形式。 字串的數據類型會決定您應該使用的這個函式形式。
| String 資料類型 | 字串常值 | 函式 |
|---|---|---|
| char | "字串" | StringCchPrintfA |
| TCHAR | TEXT (“string”) | StringCchPrintf |
| WCHAR | L“string” | StringCchPrintfW |
範例
下列範例示範使用四個自變數的 StringCchPrintf 簡單用法。
TCHAR pszDest[30];
size_t cchDest = 30;
LPCTSTR pszFormat = TEXT("%s %d + %d = %d.");
TCHAR* pszTxt = TEXT("The answer is");
HRESULT hr = StringCchPrintf(pszDest, cchDest, pszFormat, pszTxt, 1, 2, 3);
// The resultant string at pszDest is "The answer is 1 + 2 = 3."
注意
strsafe.h 標頭會將 StringCchPrintf 定義為別名，根據 UNICODE 預處理器常數的定義，自動選取此函式的 ANSI 或 Unicode 版本。 混合使用編碼中性別名與非編碼中性的程序代碼，可能會導致編譯或運行時間錯誤不符。 如需詳細資訊，請參閱 函式原型的慣例。
規格需求
| 需求 | 值 |
|---|---|
| 最低支援的用戶端 | Windows XP with SP2 [傳統型應用程式 |UWP 應用程式] |
| 最低支援的伺服器 | Windows Server 2003 SP1 [傳統型應用程式 |UWP 應用程式] |
| 目標平台 | Windows |
| 標頭 | strsafe.h |
另請參閱
參考