共用方式為

StringCchPrintf_lExA函式 (strsafe.h)

  • 發行項

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

StringCchPrintf_lEx 類似於 StringCchPrintfEx ，但包含地區設定資訊的參數。

語法

STRSAFEAPI StringCchPrintf_lExA(
  [out]           STRSAFE_LPSTR                                  pszDest,
  [in]            size_t                                         cchDest,
  [out]           STRSAFE_LPSTR                                  *ppszDestEnd,
  [out, optional] size_t                                         *pcchRemaining,
  [in]            DWORD                                          dwFlags,
  [in]            _Printf_format_string_params_(2)STRSAFE_LPCSTR pszFormat,
  [in]            _locale_t                                      locale,
                  ...                                            
);

參數

[out] pszDest

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

[in] cchDest

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

[out] ppszDestEnd

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

[out, optional] pcchRemaining

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

[in] dwFlags

下列一或多個值。

值 意義
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

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

[in] locale

地區設定物件。 如需詳細資訊，請參閱 _create_locale。

...

要插入 pszFormat 字串的 Arguments。

傳回值

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

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

備註

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

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

若要使用此函式，您必須先在頭檔中定義下列宏，才能包含 StrSafe.h。

#define STRSAFE_LOCALE_FUNCTIONS

注意

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

規格需求

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