StringCchVPrintf_lExA函式 (strsafe.h)
使用引數清單的指標,將格式化的資料寫入指定的字串。 目的地緩衝區的大小會提供給 函式,以確保其不會寫入超過這個緩衝區的結尾。
StringCchVPrintf_lEx 類似于 StringCchVPrintfEx ,但包含地區設定資訊的參數。
語法
STRSAFEAPI StringCchVPrintf_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,
[in] va_list argList
);
參數
[out] pszDest
目的地緩衝區,接收從 pszFormat 和 argList建立的格式化、以 Null 結束的字串。
[in] cchDest
目的地緩衝區的大小,以字元為單位。 這個值必須夠大,才能容納最終格式化字串加上 1,以考慮終止的 Null 字元。 允許的最大字元數是 STRSAFE_MAX_CCH。
[out] ppszDestEnd
pszDest結尾的指標位址。 如果 ppszDestEnd 為非Null ,且任何資料都複製到目的地緩衝區,這會指向字串結尾的終止 Null 字元。
[out, optional] pcchRemaining
pszDest中未使用的字元數目,包括終止的 Null 字元。 如果 pcchRemaining 為 Null,則不會保留或傳回計數。
[in] dwFlags
下列一或多個值。
[in] pszFormat
格式字串。 此字串必須以 Null 結束。 如需詳細資訊,請參閱 格式規格語法。
[in] locale
地區設定物件。 如需詳細資訊,請參閱 _create_locale。
[in] argList
要插入 pszFormat 字串中的引數。
傳回值
此函式可以傳回下列其中一個值。 強烈建議您使用 SUCCEEDED 和 FAILED 宏來測試此函式的傳回值。
傳回碼 | 描述 |
---|---|
|
有足夠的空間可將結果複製到 pszDest ,而不會截斷,而且緩衝區是以 Null 結束。 |
|
cchDest中的值為 0 或大於STRSAFE_MAX_CCH,或目的地緩衝區已滿。 |
|
複製作業因為緩衝區空間不足而失敗。 根據 dwFlags的值,目的地緩衝區可能包含已截斷且以 Null 終止之預期結果的版本。 在可接受截斷的情況下,這可能不一定被視為失敗狀況。 |
備註
如需va_lists的詳細資訊,請參閱 Stdarg.h 中定義的慣例。
如果 pszDest、 pszFormat或任何引數字串所指向的字串重迭,則行為是未定義的。
除非指定了 STRSAFE_IGNORE_NullS旗標,否則pszFormat或pszDest都不應該是Null,在此情況下兩者可能是Null。 不過,即使忽略 Null 值,仍可能會傳回因空間不足而造成的錯誤。
若要使用此函式,您必須先在標頭檔中定義下列宏,才能包含 StrSafe.h。
#define STRSAFE_LOCALE_FUNCTIONS
注意
strsafe.h 標頭會將StringCchVPrintf_lEx定義為別名,根據 UNICODE 預處理器常數的定義,自動選取此函式的 ANSI 或 Unicode 版本。 混合使用編碼中性別名與非編碼中性的程式碼,可能會導致編譯或執行時間錯誤不符。 如需詳細資訊,請參閱 函式原型的慣例。
規格需求
最低支援的用戶端 | Windows Vista [傳統型應用程式 |UWP 應用程式] |
最低支援的伺服器 | Windows Server 2008 [傳統型應用程式 |UWP 應用程式] |
目標平台 | Windows |
標頭 | strsafe.h |