StringCchCopyNExW 関数 (strsafe.h)

指定した文字数を 1 つの文字列から別の文字列にコピーします。 コピー先バッファーのサイズは、 関数に提供され、このバッファーの末尾を越えて書き込まれないことを確認します。

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

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

• strncpy、wcsncpy、_tcsncpy

構文

STRSAFEAPI StringCchCopyNExW(
  [out]           STRSAFE_LPWSTR  pszDest,
  [in]            size_t          cchDest,
  [in]            STRSAFE_PCNZWCH pszSrc,
  [in]            size_t          cchToCopy,
  [out, optional] STRSAFE_LPWSTR  *ppszDestEnd,
  [out, optional] size_t          *pcchRemaining,
  [in]            DWORD           dwFlags
);

パラメーター

[out] pszDest

種類: LPTSTR

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

[in] cchDest

種類: size_t

pszDest のサイズ (文字単位)。 この値は、コピーされた文字 ( pszSrc の長さ、 または cchSrc の値のいずれか小さい方) を保持するのに十分な大きさに、終端の null 文字を考慮するために 1 を加えた値である必要があります。 使用できる最大文字数は STRSAFE_MAX_CCH。

[in] pszSrc

型: LPCTSTR

ソース文字列。 この文字列は、 cchSrc 文字または null ターミネータのいずれか早い方まで読み取り可能である必要があります。

[in] cchToCopy

種類: size_t

pszSrc から pszDest にコピーする最大文字数。

[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 値を返します。

注釈

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

このルーチンは strncpy の代わりとして使用されますが、動作には違いがあります。 cchSrc が pszSrc の文字数より大きい場合、stringCchCopyNEx は strncpy とは異なり、cchSrc 文字がコピーされるまで pszDest を null 文字で埋め続けられません。

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

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

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

要件

関連項目

参照

StringCbCopyNEx

StringCchCopyN