StringCchCatExA 関数 (strsafe.h)
1 つの文字列を別の文字列に連結します。 コピー先バッファーのサイズは、このバッファーの末尾を越えて書き込まれないように、関数に提供されます。
StringCchCatEx は、宛先文字列 の末尾へのポインターと、その文字列で使用されていない文字数を返すことによって、StringCchCat の機能を追加します。 フラグは、追加の制御のために関数に渡すこともできます。
StringCchCatEx は、次の関数の代わりに使用されます。
- strcat、wcscat、_tcsat
-
lstrcat を
する - StrCat
- StrCatBuff
構文
STRSAFEAPI StringCchCatExA(
[in, 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
);
パラメーター
[in, out] pszDest
型: LPTSTR
コピー先バッファー。pszSrcに連結される文字列
[in] cchDest
型: size_t
変換先バッファーのサイズ (文字数)。 この値は、pszSrc の長さと、pszDest の長さに 1 を加算して、文字列と終端の null 文字の両方を考慮する必要があります。 使用できる最大文字数は STRSAFE_MAX_CCHです。
[in] pszSrc
型: LPCTSTR
pszDestの末尾
[out, optional] ppszDestEnd
型: LPTSTR*
pszDestの末尾へのポインター
[out, optional] pcchRemaining
型: size_t*
pszDest内の未使用文字の数 (終端の null 文字を含む)。 pcchRemaining
[in] dwFlags
型: DWORD
次の値のうち 1 つ以上。
価値 | 意味 |
---|---|
|
関数が成功した場合、 |
|
空 文字列 (TEXT("")) のように NULL 文字列ポインターを扱います。 このフラグは、lstrcpyなどの関数をエミュレートする場合に便利です。 |
|
関数が失敗した場合、 |
|
関数が失敗した場合、pszDest は空の文字列 (TEXT("")) に設定されます。 STRSAFE_E_INSUFFICIENT_BUFFER エラーが発生した場合、コピー先バッファー内の既存の文字列または切り捨てられた文字列が上書きされます。 |
|
関数が失敗した場合、pszDest は変更されません。 元のコンテンツには何も追加されません。 |
戻り値
型: HRESULT
この関数は、次のいずれかの値を返すことができます。 この関数の戻り値をテストするには、
リターン コード | 形容 |
---|---|
|
ソース データが存在し、文字列は切り捨てずに完全に連結され、結果の宛先バッファーは null で終了します。 |
|
cchDest の値が 0 または STRSAFE_MAX_CCHより大きいか、または宛先バッファーが既にいっぱいです。 |
|
バッファー領域が不足しているため、コピー操作に失敗しました。 dwFlagsの値によっては、コピー先バッファーに、意図した結果の切り捨てられた null で終わるバージョンが含まれている場合があります。 切り捨てが許容される状況では、これは必ずしも失敗状態と見なされない場合があります。 |
この関数は、置き換える関数とは異なり、HRESULT 値を返します。
備考
StringCchCatEx は、コード内で適切なバッファー処理のための追加処理を提供します。 バッファーの処理が不適切なのは、バッファー オーバーランを伴う多くのセキュリティの問題に関係しています。 StringCchCatEx 常に null 終了し、操作中にソース文字列の内容が変更された場合でも、有効な宛先バッファーをオーバーフローすることはありません。
pszSrc が指す文字列と pszDest
pszSrc
StringCchCatEx は、その一般的な形式またはより具体的な形式で使用できます。 次の表に示すように、文字列のデータ型によって、使用する必要があるこの関数の形式が決まります。
文字列データ型 | 文字列リテラル | 機能 |
---|---|---|
char を |
"string" | StringCchCatExA の |
TCHAR の |
TEXT("string") | StringCchCatEx |
WCHAR の |
L"string" | StringCchCatExW |
手記
strsafe.h ヘッダーは、Unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして StringCchCatEx を定義します。 エンコードに依存しないエイリアスをエンコードに依存しないコードと組み合わせて使用すると、コンパイルエラーやランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「関数プロトタイプの 規則」を参照してください。
必要条件
要件 | 価値 |
---|---|
サポートされる最小クライアント | Windows XP と SP2 [デスクトップ アプリ |UWP アプリ] |
サポートされる最小サーバー | Windows Server 2003 SP1 [デスクトップ アプリ |UWP アプリ] |
ターゲット プラットフォーム の |
ウィンドウズ |
ヘッダー | strsafe.h |
関連項目
リファレンス
StringCbCatEx の