StringCchCopyExA 関数 (strsafe.h)

1 つの文字列を別の文字列にコピーします。 コピー先バッファーのサイズは、バッファーの末尾を超えて書き込まれないよう、関数に提供されます。

StringCchCopyEx は 、宛先文字列の末尾へのポインターと、その文字列で使用されていない文字数を返すことによって 、StringCchCopy の機能を追加します。 フラグは、追加の制御のためにこの関数に渡すこともできます。

StringCchCopyEx は、次の関数に代わる関数です。

• strcpy、wcscpy、_tcscpy
• lstrcpy
• Strcpy

構文

STRSAFEAPI StringCchCopyExA(
  [out]           STRSAFE_LPSTR  pszDest,
  [in]            size_t         cchDest,
  [in]            STRSAFE_LPCSTR pszSrc,
  [out, optional] STRSAFE_LPSTR  *ppszDestEnd,
  [out, optional] size_t         *pcchRemaining,
  [in]            DWORD          dwFlags
);

パラメーター

[out] pszDest

種類: LPTSTR

コピーされた文字列を受け取る宛先バッファー。

[in] cchDest

種類: size_t

変換先バッファーのサイズ (文字数)。 この値は、コピーされたソース文字列と終端の null 文字を考慮するために 、pszSrc の長さに 1 を加えた値と等しい必要があります。 使用できる最大文字数は STRSAFE_MAX_CCH。

[in] pszSrc

種類: LPCTSTR

ソース文字列。 この文字列は null で終わる必要があります。

[out, optional] ppszDestEnd

種類: LPTSTR*

pszDest の末尾へのポインターのアドレス。 ppszDestEnd が NULL 以外で、データがコピー先バッファーにコピーされる場合、これは文字列の末尾にある終端の null 文字を指します。

[out, optional] pcchRemaining

種類: size_t*

pszDest の未使用文字の数 (終端の null 文字を含む)。 pcchRemaining が NULL の場合、カウントは保持されず、返されません。

[in] dwFlags

型: DWORD

次の値のうち 1 つ以上。

戻り値

型: HRESULT

この関数の戻り値をテストするには、 SUCCEEDED マクロと FAILED マクロを使用することを強くお勧めします。

この関数は、置き換える関数とは異なり、 HRESULT 値を返します。

注釈

StringCchCopyEx は、置き換える関数と比較して、コード内で適切なバッファー処理のための追加の処理を提供します。 バッファーの処理が不十分な場合は、バッファー オーバーランを伴う多くのセキュリティの問題に関係します。 StringCchCopyEx は 常に null 終了し、操作中にソース文字列の内容が変更された場合でも、有効な宛先バッファーをオーバーフローすることはありません。

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

STRSAFE_IGNORE_NULLS フラグが指定されていない限り、pszSrc も pszDest も NULL にすることはできません。この場合、両方とも NULL である可能性があります。 ただし、 NULL 値が無視されても、領域が不足しているためにエラーが返される可能性があります。

StringCchCopyEx は、一般的な形式またはより具体的な形式で使用できます。 文字列のデータ型によって、使用する必要があるこの関数の形式が決まります。

要件

関連項目

参照

StringCbCopyEx

StringCchCopy