RtlStringCchPrintfExW 関数 (ntstrsafe.h)

  • [アーティクル]

RtlStringCchPrintfExW 関数と RtlStringCchPrintfExA 関数は、指定された書式設定情報に基づく書式設定を使用して、文字カウントされたテキスト文字列を作成します。

構文

NTSTRSAFEDDI RtlStringCchPrintfExW(
  [out, optional] NTSTRSAFE_PWSTR  pszDest,
  [in]            size_t           cchDest,
  [out, optional] NTSTRSAFE_PWSTR  *ppszDestEnd,
  [out, optional] size_t           *pcchRemaining,
  [in]            DWORD            dwFlags,
  [in]            NTSTRSAFE_PCWSTR pszFormat,
                  ...              
);

パラメーター

[out, optional] pszDest

書式設定された null で終わる文字列を受け取る、呼び出し元が指定したバッファーへのポインター。 この関数は、 pszFormat によって提供される書式設定文字列と関数の引数リストの両方からこの文字列を作成します。 pszDest ポインターは NULL にできますが、STRSAFE_IGNORE_NULLSが dwFlags で設定されている場合にのみ使用できます。

[in] cchDest

変換先バッファーのサイズ (文字数)。 バッファーは、書式設定された文字列と終端の null 文字を含むのに十分な大きさである必要があります。 使用できる最大文字数はNTSTRSAFE_MAX_CCH。 pszDest が NULL の場合、cchDest は 0 である必要があります。

[out, optional] ppszDestEnd

呼び出し元が NULL 以外のアドレス ポインターを提供した場合、操作が完了すると、関数は宛先バッファーの結果の NULL 文字列ターミネータへのポインターを使用してそのアドレスを読み込みます。

[out, optional] pcchRemaining

呼び出し元が NULL 以外のアドレス ポインターを提供する場合、関数は pszDest が指すバッファー内の未使用の文字の数 (終端の null 文字を含む) でアドレスを読み込みます。

[in] dwFlags

1 つ以上のフラグと、必要に応じて塗りつぶしバイト。 フラグは次のように定義されます。

値 意味
STRSAFE_FILL_BEHIND_NULL
set と関数が成功した場合、 dwFlags の下位バイトを使用して、終端の null 文字に続く宛先バッファーの部分を埋めます。
STRSAFE_IGNORE_NULLS
設定されている場合、 pszDest または pszSrc、またはその両方を NULL にすることができます。 NULLpszSrc ポインターは、コピーできる空の文字列 (TEXT("")) のように扱われます。 NULLpszDest ポインターは、空でない文字列を受け取ることができません。
STRSAFE_FILL_ON_FAILURE
set と 関数が失敗した場合、 dwFlags の下位バイトを使用して宛先バッファー全体を埋め、バッファーは null で終了します。 この操作により、既存のバッファーの内容が上書きされます。
STRSAFE_NULL_ON_FAILURE
set で関数が失敗した場合、変換先バッファーは空の文字列 (TEXT("")) に設定されます。 この操作により、既存のバッファーの内容が上書きされます。
STRSAFE_NO_TRUNCATION
set と 関数がSTATUS_BUFFER_OVERFLOWを返す場合、変換先バッファーの内容は変更されません。

[in] pszFormat

printf スタイルの書式設定ディレクティブを含む null で終わるテキスト文字列へのポインター。 pszFormat ポインターは NULL にできますが、STRSAFE_IGNORE_NULLSが dwFlags で設定されている場合にのみ使用できます。

...

pszFormat 文字列に含まれる書式設定ディレクティブに基づいて、関数によって解釈される引数の省略可能なリスト。

戻り値

関数は、次の表に示す NTSTATUS 値のいずれかを返します。 NTSTATUS 値をテストする方法については、「NTSTATUS 値の使用」を参照してください。

リターン コード 説明
STATUS_SUCCESS
 この 成功 状態は、ソース データが存在し、出力文字列が切り捨てなしで作成され、結果の宛先バッファーが null で終了したことを意味します。
STATUS_BUFFER_OVERFLOW
 この 警告 状態は、宛先バッファーの領域が不足しているため、操作が完了しなかったことを意味します。 STRSAFE_NO_TRUNCATIONが dwFlags で設定されている場合、宛先バッファーは変更されません。 フラグが設定されていない場合、コピー先バッファーには、作成された文字列の切り捨てられたバージョンが含まれます。
STATUS_INVALID_PARAMETER
 この エラー 状態は、関数が無効な入力パラメーターを受信したことを意味します。 詳細については、次の段落を参照してください。

関数は、次の場合にSTATUS_INVALID_PARAMETER値を返します。

  • 無効なフラグが指定されました。
  • cchDest の値が最大バッファー サイズを超えています。
  • 宛先バッファーは既にいっぱいでした。
  • STRSAFE_IGNORE_NULLS フラグなしで NULL ポインターが存在しました。
  • コピー先のバッファー ポインターは NULL ですが、バッファー サイズは 0 ではありません。
  • 宛先バッファー ポインターが NULL であるか、その長さが 0 であったが、0 以外の長さのソース文字列が存在していた。

注釈

RtlStringCchPrintfExW と RtlStringCchPrintfExA は、次の関数の代わりに使用する必要があります。

  • sprintf
  • swprintf
  • _snprintf
  • _snwprintf
これらの関数はすべて、書式指定文字列と引数の一覧を受け取り、書式設定された文字列を返します。 RtlStringCchPrintfExW と RtlStringCchPrintfExA は、コピー先バッファーのサイズ (文字数) を受け入れて、このバッファーの末尾を超えて書き込まないようにします。

RtlStringCchPrintfExW と RtlStringCchPrintfExA は 、コピー先の文字列の末尾へのポインターと、その文字列で使用されていない文字数を返すことによって、 RtlStringCchPrintf の機能を追加します。 フラグは、追加の制御のために関数に渡すことができます。

RtlStringCchPrintfExW を使用して Unicode 文字列を処理し、RtlStringCchPrintfExA を使用して ANSI 文字列を処理します。 次の表に示すように、使用するフォームはデータによって異なります。

文字列データ型 文字列リテラル 機能
WCHAR L"string" RtlStringCchPrintfExW
char "string" RtlStringCchPrintfExA
 

pszDest と pszFormat が重複する文字列を指している場合、または引数文字列が重複している場合、関数の動作は未定義です。

STRSAFE_IGNORE_NULLS フラグが設定されていない限り、 pszSrc も pszDest も NULL にすることはできません。この場合、どちらか一方または両方を NULL にすることができます。 pszDest が NULL の場合、pszSrc は NULL であるか、空の文字列を指している必要があります。

安全な文字列関数の詳細については、「安全な文字列関数の 使用」を参照してください。

要件

要件 値
サポートされている最小のクライアント Service Pack 1 (SP1) 以降のバージョンの Windows XP で使用できます。
対象プラットフォーム デスクトップ
Header ntstrsafe.h (Ntstrsafe.h を含む)
Library Ntstrsafe.lib
IRQL PASSIVE_LEVEL

こちらもご覧ください

RtlStringCbPrintfEx

RtlStringCchPrintf

RtlStringCchVPrintfEx