次の方法で共有

StringCbCatW 関数 (strsafe.h)

  • [アーティクル]

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

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

構文

STRSAFEAPI StringCbCatW(
  [in, out] STRSAFE_LPWSTR  pszDest,
  [in]      size_t          cbDest,
  [in]      STRSAFE_LPCWSTR pszSrc
);

パラメーター

[in, out] pszDest

型: LPTSTR

pszSrc 連結する文字列。結果の文字列全体を受け取ります。 pszSrc の文字列は、pszDestの文字列の末尾 追加されます。

[in] cbDest

型: size_t

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

[in] pszSrc

型: LPCTSTR

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

戻り値

型: HRESULT

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

リターン コード 形容
S_OK
 ソース データが存在し、文字列は切り捨てずに完全に連結され、結果の宛先バッファーは null で終了します。
STRSAFE_E_INVALID_PARAMETER
 cbDest の値 未満か、許容される最大値より大きい値です。
STRSAFE_E_INSUFFICIENT_BUFFER
 バッファー領域が不足しているため、連結操作に失敗しました。 コピー先バッファーには、意図した結果の、null で終わる切り捨てられたバージョンが含まれています。 切り捨てが許容される状況では、これは必ずしも失敗状態と見なされない場合があります。
 

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

備考

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

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

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

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

pszSrc も pszDest も NULLしないでください。 null 文字列ポインター値 処理する必要がある場合は、StringCbCatEx を参照してください。

手記

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

必要条件

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

関連項目

リファレンス

StringCbCatEx の

StringCbCatN の

StringCchCat