次の方法で共有

StringCbCatNExW 関数 (strsafe.h)

  • [アーティクル]

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

StringCbCatNEx は、次の関数の代わりに使用されます。

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

構文

STRSAFEAPI StringCbCatNExW(
  [in, out]       STRSAFE_LPWSTR  pszDest,
  [in]            size_t          cbDest,
  [in]            STRSAFE_PCNZWCH pszSrc,
  [in]            size_t          cbToAppend,
  [out, optional] STRSAFE_LPWSTR  *ppszDestEnd,
  [out, optional] size_t          *pcbRemaining,
  [in]            DWORD           dwFlags
);

パラメーター

[in, out] pszDest

型: LPTSTR

コピー先バッファー。pszSrcと連結される文字列 含まれ、結果の文字列全体を受け取ります。 pszSrc の文字列は、pszDestの文字列の末尾 追加されます。

[in] cbDest

型: size_t

コピー先バッファーのサイズ (バイト単位)。 この値は、pszSrc の長さと、pszDest の長さと、終端の null 文字に使用されるバイト数を考慮する必要があります。 許容される最大バイト数は STRSAFE_MAX_CCH * sizeof(TCHAR)です。

[in] pszSrc

型: LPCTSTR

pszDestの末尾 連結されるソース文字列。 この文字列は null で終わる必要があります。

[in] cbToAppend

型: size_t

pszDest追加する最大バイト数。

[out, optional] ppszDestEnd

型: LPTSTR*

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

[out, optional] pcbRemaining

型: size_t*

pszDest内の未使用のバイト数 (終端の null 文字に使用されたものも含む)。 pcbRemaining が NULL場合、カウントは保持されず、返されません。

[in] dwFlags

型: DWORD

次の値のうち 1 つ以上。

価値 意味
STRSAFE_FILL_BEHIND_NULL
0x00000200
 関数が成功した場合、dwFlags (0) の下位バイトを使用して、終端の null 文字に続く pszDest 初期化されていない部分を埋めます。
STRSAFE_IGNORE_NULLS
0x00000100
 空 文字列 (TEXT("")) のように NULL 文字列ポインターを扱います。
STRSAFE_FILL_ON_FAILURE
0x00000400
 関数が失敗した場合、dwFlags (0) の下位バイトが pszDest バッファー全体 埋めるために使用され、バッファーは null で終了します。 STRSAFE_E_INSUFFICIENT_BUFFER エラーが発生した場合、コピー先バッファー内の既存の文字列または切り捨てられた文字列が上書きされます。
STRSAFE_NULL_ON_FAILURE
0x00000800
 関数が失敗した場合、pszDest は空の文字列 (TEXT("")) に設定されます。 STRSAFE_E_INSUFFICIENT_BUFFER エラーが発生した場合、コピー先バッファー内の既存の文字列または切り捨てられた文字列が上書きされます。
STRSAFE_NO_TRUNCATION
0x00001000
 関数が失敗した場合、pszDest は変更されません。 元のコンテンツには何も追加されません。

戻り値

型: HRESULT

この関数は、次のいずれかの値を返すことができます。 この関数の戻り値をテストするには、SUCCEEDED と FAILED マクロを することを強くお勧めします。

リターン コード 形容
S_OK
 ソース データが存在し、文字列は切り捨てずに連結され、結果の宛先バッファーは null で終了します。
STRSAFE_E_INVALID_PARAMETER
 cbDest の値が より大きいか、無効なフラグが渡されたか、pszDestのサイズ、cbDest、および pszSrcに追加するマテリアルの量に不一致があります。
STRSAFE_E_INSUFFICIENT_BUFFER
 バッファー領域が不足しているため、コピー操作に失敗しました。 dwFlagsの値によっては、コピー先バッファーに、意図した結果の切り捨てられた null で終わるバージョンが含まれている場合があります。 切り捨てが許容される状況では、これは必ずしも失敗状態と見なされない場合があります。
 

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

備考

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

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

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

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

文字列データ型 文字列リテラル 機能
char を する "string" StringCbCatNExA の
TCHAR の TEXT("string") StringCbCatNEx の
WCHAR の L"string" StringCbCatNExW の
 

手記

strsafe.h ヘッダーは、Unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして StringCbCatNEx を定義します。 エンコードに依存しないエイリアスをエンコードに依存しないコードと組み合わせて使用すると、コンパイルエラーやランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「関数プロトタイプの 規則」を参照してください。

必要条件

要件 価値
サポートされる最小クライアント Windows XP と SP2 [デスクトップ アプリ |UWP アプリ]
サポートされる最小サーバー Windows Server 2003 SP1 [デスクトップ アプリ |UWP アプリ]
ターゲット プラットフォーム の ウィンドウズ
ヘッダー strsafe.h

関連項目

リファレンス

StringCbCatEx の

StringCbCatN の

StringCchCatNEx