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