RtlStringCbCopyExW 関数 (ntstrsafe.h)
RtlStringCbCopyExW 関数と RtlStringCbCopyExA 関数は、バイトカウント文字列をバッファーにコピーします。
構文
NTSTRSAFEDDI RtlStringCbCopyExW(
[out, optional] NTSTRSAFE_PWSTR pszDest,
[in] size_t cbDest,
[in, optional] NTSTRSAFE_PCWSTR pszSrc,
[out, optional] NTSTRSAFE_PWSTR *ppszDestEnd,
[out, optional] size_t *pcbRemaining,
[in] DWORD dwFlags
);
パラメーター
[out, optional] pszDest
コピーされた文字列を受け取る呼び出し元が指定したバッファーへのポインター。 pszSrc の文字列は pszDest のバッファーにコピーされ、null 文字で終わる。 pszDest ポインターは NULL にできますが、STRSAFE_IGNORE_NULLSが dwFlags で設定されている場合にのみ使用できます。
[in] cbDest
コピー先バッファーのサイズ (バイト単位)。 バッファーは、文字列と終端の null 文字に十分な大きさにする必要があります。
Unicode 文字列の場合、最大バイト数は です。 NTSTRSAFE_MAX_CCH * sizeof(WCHAR)
ANSI 文字列の場合、最大バイト数は NTSTRSAFE_MAX_CCH * sizeof(char)
pszDest が NULL の場合、cbDest は 0 である必要があります。
[in, optional] pszSrc
呼び出し元が指定した null で終わる文字列へのポインター。 pszSrc ポインターは NULL にできますが、STRSAFE_IGNORE_NULLSが dwFlags で設定されている場合にのみ使用できます。
[out, optional] ppszDestEnd
呼び出し元が NULL 以外のアドレス ポインターを指定した場合、コピー操作が完了すると、関数は宛先バッファーの結果の NULL 文字列ターミネータへのポインターを使用してそのアドレスを読み込みます。
[out, optional] pcbRemaining
呼び出し元が 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を返す場合:
|
戻り値
関数は、次の表に示す NTSTATUS 値のいずれかを返します。 NTSTATUS 値をテストする方法については、「 NTSTATUS 値の使用」を参照してください。
| リターン コード | 説明 |
|---|---|
| STATUS_SUCCESS | この 成功 状態は、ソース データが存在し、文字列が切り捨てられずにコピーされ、結果の宛先バッファーが null で終了したことを意味します。 |
| STATUS_BUFFER_OVERFLOW | この 警告 状態は、コピー先バッファーの領域が不足しているため、コピー操作が完了しなかったことを意味します。 STRSAFE_NO_TRUNCATIONが設定されている場合は、dwFlags パラメーターを参照してください。 |
| STATUS_INVALID_PARAMETER |
この エラー 状態は、関数が無効な入力パラメーターを受信したことを意味します。 詳細については、次の段落を参照してください。 関数は、次の場合にSTATUS_INVALID_PARAMETER値を返します。
|
注釈
RtlStringCbCopyExA と RtlStringCbCopyExW は、次の関数の代わりに使用する必要があります。
- strcpy
- wcscpy
コピー先バッファーのサイズ (バイト単位) は、バッファーの末尾を超えて書き込まないように、 RtlStringCbCopyExA と RtlStringCbCopyExW に提供されます。
RtlStringCbCopyEx は 、宛先文字列の末尾へのポインターと、その文字列で使用されていないバイト数を返すことによって 、RtlStringCbCopy の機能を追加します。 フラグは、追加の制御のために関数に渡すことができます。
RtlStringCbCopyExW を使用して Unicode 文字列を処理し、RtlStringCbCopyExA を使用して ANSI 文字列を処理します。 使用するフォームは、次の表に示すようにデータによって異なります。
| 文字列データ型 | 文字列リテラル | 機能 |
|---|---|---|
| Wchar | L"string" | RtlStringCbCopyExW |
| char | "string" | RtlStringCbCopyExA |
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 |
こちらもご覧ください
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示