共用方式為

StringCbVPrintfExW 函式 (strsafe.h)

  • 發行項

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

StringCbVPrintfEx 藉 由傳回目的地字串結尾的指標，以及該字串中剩餘未使用的位元組數目，以新增至 StringCbVPrintf 的功能。 旗標也可以傳遞至 函式以取得其他控制項。

StringCbVPrintfEx 是下列函式的取代專案：

語法

STRSAFEAPI StringCbVPrintfExW(
  [out]           STRSAFE_LPWSTR  pszDest,
  [in]            size_t          cbDest,
  [out, optional] STRSAFE_LPWSTR  *ppszDestEnd,
  [out, optional] size_t          *pcbRemaining,
  [in]            DWORD           dwFlags,
  [in]            STRSAFE_LPCWSTR pszFormat,
  [in]            va_list         argList
);

參數

[out] pszDest

類型： LPTSTR

目的地緩衝區，接收從 pszFormat 和 argList建立的格式化、以 Null 結束的字串。

[in] cbDest

類型： size_t

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

[out, optional] ppszDestEnd

類型： LPTSTR*

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

[out, optional] pcbRemaining

類型： size_t*

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

[in] dwFlags

類型： DWORD

下列一或多個值。

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

類型： LPCTSTR

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

[in] argList

類型： va_list

要插入 pszFormat 字串中的引數。

傳回值

類型： HRESULT

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

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

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

備註

StringCbVPrintfEx 提供額外的處理，以在程式碼中正確處理緩衝區。 在涉及緩衝區溢位的許多安全性問題中，緩衝區處理不佳。 StringCbVPrintfEx 一律會以 null 結束非零長度的目的地緩衝區。

如需va_lists的詳細資訊，請參閱 Stdarg.h 中定義的慣例。

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

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

StringCbVPrintfEx 可用於其泛型形式或更特定的表單中。 字串的資料類型會決定您應該使用的此函式形式，如下表所示。

String 資料類型 字串常值 函式
char "字串" StringCbVPrintfExA
TCHAR TEXT (「string」) StringCbVPrintfEx
WCHAR L「string」 StringCbVPrintfExW
 

注意

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

規格需求

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

另請參閱

參考

StringCbPrintfEx

StringCbVPrintf

StringCchVPrintfEx