StringCchPrintf_lA函式 (strsafe.h)
將格式化的數據寫入指定的字串。 目的地緩衝區的大小會提供給 函式,以確保它不會寫入超過這個緩衝區的結尾。
StringCchPrintf_l 類似於 StringCchPrintf,但包含地區設定資訊的參數。
語法
STRSAFEAPI StringCchPrintf_lA(
[out] STRSAFE_LPSTR pszDest,
[in] size_t cchDest,
[in] _Printf_format_string_params_(2)STRSAFE_LPCSTR pszFormat,
[in] _locale_t locale,
...
);
參數
[out] pszDest
目的緩衝區,接收從 pszFormat 及其自變數建立的格式化、null 終止字串。
[in] cchDest
目的地緩衝區的大小,以字元為單位。 這個值必須足夠大,才能容納最終格式化字串加上 1,以考慮終止的 Null 字元。 允許的最大字元數是 STRSAFE_MAX_CCH。
[in] pszFormat
格式字串。 此字串必須以 Null 結束。 如需詳細資訊,請參閱 格式規格語法。
[in] locale
地區設定物件。 如需詳細資訊,請參閱 _create_locale。
...
要插入 pszFormat 字串中的自變數。
傳回值
此函式可以傳回下列其中一個值。 強烈建議您使用 SUCCEEDED 和 FAILED 巨集來測試此函式的傳回值。
傳回碼 | 描述 |
---|---|
|
有足夠的空間可將結果複製到 pszDest 而不截斷,而緩衝區會以 Null 結束。 |
|
cchDest 中的值是 0 或大於 STRSAFE_MAX_CCH。 |
|
複製作業因為緩衝區空間不足而失敗。 目的地緩衝區包含已截斷且以 Null 終止之預期結果的版本。 在可接受截斷的情況下,這不一定被視為失敗狀況。 |
言論
如果 pszDest 所指向的字串、pszFormat或任何自變數字串重疊,則行為是未定義的。
pszFormat 或 pszDest 都不應 NULL。 如果您需要處理 null 字串指標值,請參閱 StringCchPrintf_lEx。
若要使用此函式,您必須先在頭檔中定義下列巨集,才能包含 StrSafe.h。
#define STRSAFE_LOCALE_FUNCTIONS
注意
strsafe.h 標頭會將StringCchPrintf_l定義為別名,根據 UNICODE 預處理器常數的定義,自動選取此函式的 ANSI 或 Unicode 版本。 混合使用編碼中性別名與非編碼中性的程序代碼,可能會導致編譯或運行時間錯誤不符。 如需詳細資訊,請參閱函式原型的
要求
要求 | 價值 |
---|---|
最低支援的用戶端 | Windows Vista [傳統型應用程式 |UWP 應用程式] |
支援的最低伺服器 | Windows Server 2008 [傳統型應用程式 |UWP 應用程式] |
目標平臺 | 窗戶 |
標頭 | strsafe.h |