RtlStringCchCopyNExA 関数 (ntstrsafe.h)

  • [アーティクル]

RtlStringCchCopyNExW 関数と RtlStringCchCopyNExA 関数は、コピーした文字列のサイズを制限しながら、文字数をカウントした文字列をバッファーにコピーします。

構文

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

パラメーター

[out, optional] pszDest

コピーされた文字列を受け取る呼び出し元が指定したバッファーへのポインター。 pszSrc の文字列は pszDest のバッファーにコピーされ、null 文字で終わる。 pszDest ポインターは NULL にできますが、STRSAFE_IGNORE_NULLSが dwFlags で設定されている場合にのみ使用できます。

[in] cchDest

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

[in, optional] pszSrc

呼び出し元が指定した null で終わる文字列へのポインター。

cchToCopy

pszSrc から pszDest によって提供されるバッファーにコピーする最大文字数。

[out, optional] ppszDestEnd

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

[out, optional] pcchRemaining

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

[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はそれに応じて宛先バッファーを埋めます。
  • それ以外の場合、STRSAFE_NULL_ON_FAILUREが設定されていない場合でも、コピー先バッファー の 内容は空の文字列に設定されます。 STRSAFE_FILL_BEHIND_NULL は無視されます。

戻り値

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

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

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

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

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

注釈

Strncpy の代わりに RtlStringCchCopyNExW と RtlStringCchCopyNExA を使用する必要があります。 関数は、ソース文字列から特定の数の文字をコピーします。 コピー先バッファーのサイズ (文字数) は、バッファーの末尾を超えて書き込まないように、 RtlStringCchCopyNExW と RtlStringCchCopyNExA に提供されます。

これらの関数の動作は 、strncpy とは異なる点に注意してください。 cchSrc が pszSrc、RtlStringCchCopyNExW、RtlStringCchCopyNExA の文字数より大きい場合は、strncpy とは異なり、cchSrc 文字がコピーされるまで pszDest に null 文字を埋め込み続けないでください。

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

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

文字列データ型 文字列リテラル 機能
Wchar L"string" RtlStringCchCopyNExW
char "string" RtlStringCchCopyNExA

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

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

こちらもご覧ください