RtlStringCchCatNExA 関数 (ntstrsafe.h)

  • [アーティクル]

RtlStringCchCatNExW と RtlStringCchCatNExA 関数は、追加された文字列のサイズを制限しながら、2 つの文字カウント文字列を連結します。

構文

NTSTRSAFEDDI RtlStringCchCatNExA(
  [in, out, optional] NTSTRSAFE_PSTR pszDest,
  [in]                size_t         cchDest,
  [in, optional]      STRSAFE_PCNZCH pszSrc,
                      size_t         cchToAppend,
  [out, optional]     NTSTRSAFE_PSTR *ppszDestEnd,
  [out, optional]     size_t         *pcchRemaining,
  [in]                DWORD          dwFlags
);

パラメーター

[in, out, optional] pszDest

入力時に、pszSrc を連結する null で終わる文字列 含むバッファーへのポインター。 出力時に、これは結果の文字列全体を含む宛先バッファーです。 pszSrcの文字列 (最大 cchMaxAppend 文字) が pszDest の文字列の末尾 追加され、null 文字で終了します。 pszDest ポインターは NULLできますが、dwFlagsでSTRSAFE_IGNORE_NULLSが設定されている場合にのみ 。

[in] cchDest

変換先バッファーのサイズ (文字数)。 使用できる最大文字数はNTSTRSAFE_MAX_CCH。 pszDest が NULL場合、cchDest 0 にする必要があります。

[in, optional] pszSrc

null で終わる文字列へのポインター。 この文字列は、pszDestのバッファーに格納されている文字列の末尾 連結されます。 pszSrc ポインターは NULLできますが、dwFlagsでSTRSAFE_IGNORE_NULLSが設定されている場合にのみ 。

cchToAppend

pszDestのバッファーに含まれる文字列に追加する最大文字数 指定します。

[out, optional] ppszDestEnd

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

[out, optional] pcchRemaining

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

[in] dwFlags

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

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

このフラグが設定され、関数が STATUS_BUFFER_OVERFLOWを返す場合:

  • STRSAFE_FILL_ON_FAILURE も指定されている場合、STRSAFE_NO_TRUNCATION はそれに応じて宛先バッファーを塗りつぶします。
  • それ以外の場合、宛先バッファーは変更されません。

戻り値

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

リターン コード 形容
STATUS_SUCCESS この 成功 状態は、ソース データが存在し、出力文字列が切り捨てられずに作成され、結果の宛先バッファーが null で終了したことを意味します。
STATUS_BUFFER_OVERFLOW この 警告 状態は、宛先バッファー内の領域が不足しているために操作が完了しなかったことを意味します。 STRSAFE_NO_TRUNCATION が設定されている場合は、dwFlags パラメーターを参照してください。
STATUS_INVALID_PARAMETER

この エラー 状態は、関数が無効な入力パラメーターを受信したことを意味します。 詳細については、次の段落を参照してください。

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

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

備考

RtlStringCchCatNExW 、および RtlStringCchCatNExA は、次の関数の代わりに使用する必要があります。

  • strncat を する
  • wcsncat を する

コピー先バッファーのサイズは、RtlStringCchCatNExW を し、RtlStringCchCatNExA を して、関数がバッファーの末尾を越えて書き込まないようにするために提供されます。

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

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

文字列データ型 文字列リテラル 機能
WCHAR の L"string" RtlStringCchCatNExW を する
char を する "string" RtlStringCchCatNExA の

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

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

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

必要条件

要件 価値
サポートされる最小クライアント Windows XP Service Pack 1 (SP1) 以降のバージョンの Windows で使用できます。
ターゲット プラットフォーム の デスクトップ
ヘッダー ntstrsafe.h (Ntstrsafe.h を含む)
ライブラリ Ntstrsafe.lib
IRQL 操作される文字列が常にメモリ内に存在する場合は Any、それ以外の場合は PASSIVE_LEVEL

関連項目

  • RtlStringCbCatNEx の
  • RtlStringCchCatEx の
  • RtlStringCchCatN の