StringCchPrintf_lExW関数 (strsafe.h)
指定した文字列に書式設定されたデータを書き込みます。 コピー先バッファーのサイズは、 関数に提供され、このバッファーの末尾を越えて書き込まれないことを確認します。
StringCchPrintf_lEx は StringCchPrintfEx に似ていますが、ロケール情報のパラメーターが含まれています。
構文
STRSAFEAPI StringCchPrintf_lExW(
[out] STRSAFE_LPWSTR pszDest,
[in] size_t cchDest,
[out] STRSAFE_LPWSTR *ppszDestEnd,
[out, optional] size_t *pcchRemaining,
[in] DWORD dwFlags,
[in] _Printf_format_string_params_(2)STRSAFE_LPCWSTR 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
次の値の 1 つ以上。
[in] pszFormat
書式指定文字列。 この文字列は null で終わる必要があります。 詳細については、「 書式指定構文」を参照してください。
[in] locale
ロケール オブジェクト。 詳細については、「 _create_locale」を参照してください。
...
pszFormat 文字列に挿入する引数。
戻り値
この関数は、次のいずれかの値を返すことができます。 SUCCEEDED マクロと FAILED マクロを使用して、この関数の戻り値をテストすることを強くお勧めします。
リターン コード | 説明 |
---|---|
|
結果を切り捨てずに pszDest にコピーするのに十分な領域があり、バッファーは null で終了します。 |
|
cchDest の値が 0 であるか、STRSAFE_MAX_CCHより大きいか、宛先バッファーが既にいっぱいです。 |
|
バッファー領域が不足しているため、コピー操作が失敗しました。 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 バージョンを自動的に選択します。 encoding-neutral エイリアスの使用を encoding-neutral ではないコードと混在すると、コンパイル エラーまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。
要件
要件 | 値 |
---|---|
サポートされている最小のクライアント | Windows Vista [デスクトップ アプリのみ | UWP アプリ] |
サポートされている最小のサーバー | Windows Server 2008 [デスクトップ アプリ | UWP アプリ] |
対象プラットフォーム | Windows |
ヘッダー | strsafe.h |