StringCchVPrintf_lW関数 (strsafe.h)

  • [アーティクル]

引数のリストへのポインターを使用して、書式設定されたデータを指定された文字列に書き込みます。 コピー先バッファーのサイズは、このバッファーの末尾を超えて書き込まれないようにするために、関数に提供されます。

StringCchVPrintf_l は StringCchVPrintf に似ていますが、ロケール情報のパラメーターが含まれています。

構文

STRSAFEAPI StringCchVPrintf_lW(
  [out] STRSAFE_LPWSTR                                  pszDest,
  [in]  size_t                                          cchDest,
  [in]  _Printf_format_string_params_(2)STRSAFE_LPCWSTR pszFormat,
  [in]  _locale_t                                       locale,
  [in]  va_list                                         argList
);

パラメーター

[out] pszDest

pszFormat および argList から作成された、書式設定された null で終わる文字列を受け取る宛先バッファー。

[in] cchDest

変換先バッファーのサイズ (文字数)。 この値は、最後に書式設定された文字列に 1 を加えて終端の null 文字を考慮するのに十分な大きさにする必要があります。 使用できる最大文字数は STRSAFE_MAX_CCH。

[in] pszFormat

書式指定文字列。 この文字列は null で終わる必要があります。 詳細については、「 書式指定構文」を参照してください。

[in] locale

ロケール オブジェクト。 詳細については、「 _create_locale」を参照してください。

[in] argList

pszFormat 文字列に挿入する引数。

戻り値

この関数は、次のいずれかの値を返すことができます。 この関数の戻り値をテストするには、 SUCCEEDED マクロと FAILED マクロを使用することを強くお勧めします。

リターン コード 説明
S_OK
 結果を切り捨てずに pszDest にコピーするのに十分な領域があり、バッファーは null で終了します。
STRSAFE_E_INVALID_PARAMETER
 cchDest の値は 0 か、STRSAFE_MAX_CCHより大きい値です。
STRSAFE_E_INSUFFICIENT_BUFFER
 バッファー領域が不足しているため、コピー操作に失敗しました。 コピー先バッファーには、目的の結果の null で終わる切り捨てられたバージョンが含まれています。 切り捨てが許容される状況では、これは必ずしも失敗状態と見なされない場合があります。

解説

va_listsの詳細については、Stdarg.h で定義されている規則を参照してください。

pszDest、pszFormat、または引数文字列が指す文字列が重なる場合、動作は未定義です。

pszFormat も pszDest も NULL にすることはできません。 null 文字列ポインター値の処理が必要な場合は、「 StringCchVPrintf_lEx 」を参照してください。

この関数を使用するには、StrSafe.h を含める前に、ヘッダー ファイルに次のマクロを定義する必要があります。

#define STRSAFE_LOCALE_FUNCTIONS

注意

strsafe.h ヘッダーは、unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとしてStringCchVPrintf_lを定義します。 エンコードに依存しないエイリアスをエンコードニュートラルでないコードと組み合わせて使用すると、コンパイルまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。

要件

   
サポートされている最小のクライアント Windows Vista [デスクトップ アプリのみ | UWP アプリ]
サポートされている最小のサーバー Windows Server 2008 [デスクトップ アプリ | UWP アプリ]
対象プラットフォーム Windows
ヘッダー strsafe.h