RtlStringCbCopyNW 関数 (ntstrsafe.h)

  • [アーティクル]

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

構文

NTSTRSAFEDDI RtlStringCbCopyNW(
  [out] NTSTRSAFE_PWSTR pszDest,
  [in]  size_t          cbDest,
  [in]  STRSAFE_PCNZWCH pszSrc,
        size_t          cbToCopy
);

パラメーター

[out] pszDest

コピーされた文字列を受け取る呼び出し元が指定したバッファーへのポインター。 pszSrc の文字列 (cbSrc バイトまで) は pszDest のバッファーにコピーされ、null 文字で終了します。

[in] cbDest

コピー先バッファーのサイズ (バイト単位)。 バッファーは、文字列と終端の null 文字の両方に十分な大きさである必要があります。

Unicode 文字列の場合、最大バイト数は NTSTRSAFE_MAX_CCH * sizeof(WCHAR) です。

ANSI 文字列の場合、最大バイト数は NTSTRSAFE_MAX_CCH * sizeof(char) です。

[in] pszSrc

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

cbToCopy

pszSrc から pszDest にコピーする最大バイト数。

戻り値

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

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

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

  • cbDest の値が最大バッファー サイズより大きい。
  • 宛先バッファーは既にいっぱいでした。
  • NULL ポインターが存在しました。
  • 宛先バッファーの長さは 0 ですが、0 以外の長さのソース文字列が存在しました。

注釈

strncpy の代わりに、RtlStringCbCopyNW と RtlStringCbCopyNA を使用する必要があります。 ただし、これらの関数の動作は異なります。 cbSrc が pszSrc のバイト数より大きい場合、rtlStringCbCopyN 関数は strncpy とは異なり、cbSrc バイトがコピーされるまで pszDest に null 文字を入力しません。

RtlStringCbCopyN は 、ソース文字列から特定のバイト数をコピーします。 RtlStringCbCopyN がこのバッファーの末尾を超えて書き込まれないように、コピー先バッファーのサイズ (バイト単位) が関数に提供されます。

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

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

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

pszSrc も pszDest も NULL にすることはできません。 NULL 文字列ポインター値を処理する必要がある場合は、「RtlStringCbCopyNEx」を参照してください。

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

要件

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

こちらもご覧ください

RtlStringCbCopy

RtlStringCbCopyNEx

RtlStringCchCopyN