RtlUnicodeStringCbCopyN 関数 (ntstrsafe.h)
RtlUnicodeStringCbCopyN 関数は、コピーした文字列のサイズを制限しながら、1 つのUNICODE_STRING構造体から別の構造体に文字列をコピーします。
構文
NTSTRSAFEDDI RtlUnicodeStringCbCopyN(
[out] PUNICODE_STRING DestinationString,
[in] PCUNICODE_STRING SourceString,
[in] size_t cbToCopy
);
パラメーター
[out] DestinationString
コピーした文字列を受け取る UNICODE_STRING 構造体へのポインター。 SourceString パラメーターの UNICODE_STRING 構造体が指す文字列は、DestinationString パラメーターの UNICODE_STRING 構造体が指すバッファーにコピーされます。 DestinationString 構造体の文字列バッファー内の最大バイト数は、NTSTRSAFE_UNICODE_STRING_MAX_CCH * sizeof(WCHAR) です。
[in] SourceString
コピーする文字列を含む UNICODE_STRING 構造体へのポインター。 構造体の文字列バッファー内の最大バイト数は NTSTRSAFE_UNICODE_STRING_MAX_CCH * sizeof(WCHAR) です。
[in] cbToCopy
ソースからコピー先にコピーされるバイト数。
戻り値
RtlUnicodeStringCbCopyN は 、次のいずれかの NTSTATUS 値を返します。
リターン コード | 説明 |
---|---|
|
この 成功 状態は、ソース データが存在し、文字列が切り捨てられずにコピーされたことを意味します。 |
|
この 警告 状態は、バッファー領域が不足しているためにコピー操作が完了しなかったことを意味します。 コピー先バッファーには、目的の結果の切り捨てられたバージョンが含まれています。 |
|
この エラー 状態は、関数が無効な入力パラメーターを受信したことを意味します。 詳細については、次の段落を参照してください。 |
RtlUnicodeStringCbCopyN は、次のいずれかの場合にSTATUS_INVALID_PARAMETER値を返します。
- UNICODE_STRING構造体の内容が無効です。
- 宛先バッファーは既にいっぱいです。
- バッファー ポインターが NULL です。
- コピー先バッファーの長さは 0 ですが、0 以外の長さのソース文字列が存在します。
- cbToCopy パラメーターの値が NTSTRSAFE_UNICODE_STRING_MAX_CCH * sizeof(WCHAR) を超えています。
注釈
RtlUnicodeStringCbCopyN 関数は、コピー先バッファーのサイズを使用して、コピー操作がバッファーの末尾を超えて書き込まれないようにします。 関数は、結果の文字列を null 文字値 (つまり 0) で終了 しません 。
ソース文字列と変換先の文字列が重複する場合、関数の動作は未定義です。
SourceString ポインターと DestinationString ポインターを NULL にすることはできません。 NULL ポインター値を処理する必要がある場合は、RtlUnicodeStringCbCopyNEx 関数を使用します。
安全な文字列関数の詳細については、「安全な文字列関数の 使用」を参照してください。
要件
要件 | 値 |
---|---|
サポートされている最小のクライアント | Service Pack 1 (SP1) 以降のバージョンの Windows XP で使用できます。 |
対象プラットフォーム | デスクトップ |
Header | ntstrsafe.h (Ntstrsafe.h を含む) |
Library | Ntstrsafe.lib |
IRQL | 操作される文字列が常にメモリ内に存在する場合は 、それ以外の場合は PASSIVE_LEVEL |