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