共用方式為

StringCchPrintfExA 函式 （strsafe.h）

  • 發行項

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

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

StringCchPrintfEx 取代下列函式：

語法

STRSAFEAPI StringCchPrintfExA(
  [out]           STRSAFE_LPSTR  pszDest,
  [in]            size_t         cchDest,
  [out, optional] STRSAFE_LPSTR  *ppszDestEnd,
  [out, optional] size_t         *pcchRemaining,
  [in]            DWORD          dwFlags,
  [in]            STRSAFE_LPCSTR 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 字元。 如果 pcchRemainingNULL，則不會保留或傳回計數。

[in] dwFlags

類型：DWORD

下列一或多個值。

價值 意義
STRSAFE_FILL_BEHIND_NULL
0x00000200
 如果函式成功，則會使用 dwFlags （0） 的低位元組來填入 pszDest 的未初始化部分，並遵循終止的 null 字元。
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 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 可用於其泛型表單或更特定的表單。 字串的數據類型會決定您應該使用的這個函式形式。

字串數據類型 字串常值 功能
char “string” StringCchPrintfExA
TCHAR TEXT（“string”） StringCchPrintfEx
WCHAR L“string” StringCchPrintfExW
 

注意

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

要求

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

另請參閱

參考

StringCbPrintfEx

StringCchPrintf

StringCchVPrintfEx