StringCbCatA 関数 (strsafe.h)

  • [アーティクル]

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

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

構文

STRSAFEAPI StringCbCatA(
  [in, out] STRSAFE_LPSTR  pszDest,
  [in]      size_t         cbDest,
  [in]      STRSAFE_LPCSTR 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 の値は、許容される最大値よりsizeof(TCHAR)小さいか、より大きいかのいずれかです。
STRSAFE_E_INSUFFICIENT_BUFFER
 バッファー領域が不足しているため、連結操作に失敗しました。 コピー先バッファーには、目的の結果の null で終わる切り捨てられたバージョンが含まれています。 切り捨てが許容される状況では、これは必ずしも失敗状態と見なされない場合があります。
 

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

解説

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

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

文字列型 (String) リテラル文字列 機能
char "string" StringCbCatA
TCHAR TEXT("string") StringCbCat
Wchar L"string" StringCbCatW
 

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

pszSrc も pszDest も NULL にすることはできません。 null 文字列ポインター値の処理が必要な場合は、「 StringCbCatEx 」を参照してください。

注意

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

要件

   
サポートされている最小のクライアント SP2 を使用した Windows XP [デスクトップ アプリ |UWP アプリ]
サポートされている最小のサーバー WINDOWS Server 2003 SP1 [デスクトップ アプリ |UWP アプリ]
対象プラットフォーム Windows
ヘッダー strsafe.h

関連項目

参照

StringCbCatEx

StringCbCatN

StringCchCat