StringCbCopyExA 関数 (strsafe.h)

[アーティクル]
03/02/2024

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

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

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

構文

STRSAFEAPI StringCbCopyExA(
  [out]           STRSAFE_LPSTR  pszDest,
  [in]            size_t         cbDest,
  [in]            STRSAFE_LPCSTR pszSrc,
  [out, optional] STRSAFE_LPSTR  *ppszDestEnd,
  [out, optional] size_t         *pcbRemaining,
  [in]            DWORD          dwFlags
);

パラメーター

[out] pszDest

種類: LPTSTR

コピーされた文字列を受け取る宛先バッファー。

[in] cbDest

種類: size_t

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

[in] pszSrc

種類: LPCTSTR

ソース文字列。この文字列は null で終わる必要があります。

[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	NULL 文字列ポインターを空の文字列 (TEXT("")) のように扱います。このフラグは、 lstrcpy などの関数をエミュレートする場合に便利です。
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	STRSAFE_NULL_ON_FAILUREの場合と同様に、関数が失敗した場合、pszDest は空の文字列 (TEXT("")) に設定されます。 STRSAFE_E_INSUFFICIENT_BUFFERエラーが発生した場合は、切り捨てられた文字列が上書きされます。

戻り値

型: HRESULT

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

リターンコード	説明
S_OK	ソースデータが存在し、切り捨てなしで完全にコピーされ、結果のコピー先バッファーは null で終了します。
STRSAFE_E_INVALID_PARAMETER	コピーするソースデータが存在する場合は pszDest が NULL であるか、無効なフラグが渡されました。
STRSAFE_E_INSUFFICIENT_BUFFER	バッファー領域が不足しているため、コピー操作に失敗しました。 dwFlags の値によっては、ターゲットバッファーに、意図した結果の切り捨てられた null で終わるバージョンが含まれている場合があります。切り捨てが許容される状況では、これは必ずしも失敗状態と見なされない場合があります。

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

注釈

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

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

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

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

文字列型 (String)	リテラル文字列	機能
char	"string"	StringCbCopyExA
TCHAR	TEXT("string")	StringCbCopyEx
Wchar	L"string"	StringCbCopyExW

注意

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

要件

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

次の方法で共有

StringCbCopyExA 関数 (strsafe.h)

構文

パラメーター

戻り値

注釈

要件

関連項目

フィードバック

その他のリソース