RtlStringCchCopyA 関数 (ntstrsafe.h)

RtlStringCchCopyW 関数と RtlStringCchCopyA 関数は、null で終わるソース文字列を、指定した長さの宛先バッファーにコピーします。

構文

NTSTRSAFEDDI RtlStringCchCopyA(
  [out] NTSTRSAFE_PSTR  pszDest,
  [in]  size_t          cchDest,
  [in]  NTSTRSAFE_PCSTR pszSrc
);

パラメーター

[out] pszDest

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

[in] cchDest

変換先バッファーのサイズ (文字単位)。 使用できる最大文字数はNTSTRSAFE_MAX_CCH。

[in] pszSrc

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

戻り値

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

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

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

  • cchDest の値が最大バッファー サイズを超えています。
  • NULL ポインターが存在しました。
  • 宛先バッファーの長さは、入力時にゼロでした。

注釈

RtlStringCchCopyWRtlStringCchCopyA は、次の関数の代わりに使用する必要があります。

  • strcpy
  • wcscpy
これらの関数は strncpy に代わるものではありません。 strncpy を置き換えるには、RtlStringCchCopyN または RtlStringCchCopyNEx を使用します。

コピー先バッファーのサイズ (文字単位) は、バッファーの末尾を越えて書き込まないように、 RtlStringCchCopyWRtlStringCchCopyA に提供されます。

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

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

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

pszSrcpszDestNULL にすることはできません。 NULL 文字列ポインター値を処理する必要がある場合は、RtlStringCchCopyEx を使用します

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

要件

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

こちらもご覧ください

RtlStringCbCopy

RtlStringCchCopyEx