共用方式為

StringCbPrintfW 函式 （strsafe.h）

  • 發行項

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

StringCbPrintf 取代下列函式：

語法

STRSAFEAPI StringCbPrintfW(
  [out] STRSAFE_LPWSTR  pszDest,
  [in]  size_t          cbDest,
  [in]  STRSAFE_LPCWSTR pszFormat,
        ...             
);

參數

[out] pszDest

類型：LPTSTR

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

[in] cbDest

類型：size_t

目的地緩衝區的大小，以位元組為單位。 這個值必須足夠大，才能容納最終格式化字串加上終止的 Null 字元。 允許的位元元數目上限為 STRSAFE_MAX_CCH * sizeof(TCHAR)。

[in] pszFormat

類型：LPCTSTR

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

...

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

傳回值

類型：HRESULT

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

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

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

言論

與其取代的函式相比，StringCbPrintf 提供額外的處理，以在程式碼中處理適當的緩衝區。 不良的緩衝區處理牽涉到涉及緩衝區滿溢的許多安全性問題。 StringCbPrintf 一律以 null 結束非零長度的目的地緩衝區。

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

pszFormat 或 pszDest 都不應 NULL。 如果您需要處理 null 字串指標值，請參閱 StringCbPrintfEx。

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

字串數據類型 字串常值 功能
char “string” StringCbPrintfA
TCHAR TEXT（“string”） StringCbPrintf
WCHAR L“string” StringCbPrintfW
 

例子

下列範例示範使用四個自變數 StringCbPrintf的基本用法。

int const arraysize = 30;
TCHAR pszDest[arraysize]; 
size_t cbDest = arraysize * sizeof(TCHAR);

LPCTSTR pszFormat = TEXT("%s %d + %d = %d.");
TCHAR* pszTxt = TEXT("The answer is");

HRESULT hr = StringCbPrintf(pszDest, cbDest, pszFormat, pszTxt, 1, 2, 3);

// The resultant string at pszDest is "The answer is 1 + 2 = 3."

注意

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

要求

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

另請參閱

參考

StringCbPrintfEx

StringCbVPrintf

StringCchPrintf