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 文字列に挿入する引数。
戻り値
この関数は、次のいずれかの値を返すことができます。 この関数の戻り値をテストするには、
リターン コード | 形容 |
---|---|
|
結果を切り捨てずに pszDest |
|
cchDest の値は、0 または STRSAFE_MAX_CCHより大きい値です。 |
|
バッファー領域が不足しているため、コピー操作に失敗しました。 コピー先バッファーには、意図した結果の、null で終わる切り捨てられたバージョンが含まれています。 切り捨てが許容される状況では、これは必ずしも失敗状態と見なされない場合があります。 |
備考
pszDest、
pszFormat
この関数を使用するには、StrSafe.h を含める前に、ヘッダー ファイルに次のマクロを定義する必要があります。
#define STRSAFE_LOCALE_FUNCTIONS
手記
strsafe.h ヘッダーは、unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとしてStringCchPrintf_lを定義します。 エンコードに依存しないエイリアスをエンコードに依存しないコードと組み合わせて使用すると、コンパイルエラーやランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「関数プロトタイプの 規則」を参照してください。
必要条件
要件 | 価値 |
---|---|
サポートされる最小クライアント | Windows Vista [デスクトップ アプリ |UWP アプリ] |
サポートされる最小サーバー | Windows Server 2008 [デスクトップ アプリ |UWP アプリ] |
ターゲット プラットフォーム の |
ウィンドウズ |
ヘッダー | strsafe.h |