StringCchCopyExA 関数 (strsafe.h)

  • [アーティクル]

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

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

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

構文

STRSAFEAPI StringCchCopyExA(
  [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
);

パラメーター

[out] pszDest

種類: LPTSTR

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

[in] cchDest

種類: size_t

変換先バッファーのサイズ (文字数)。 この値は、コピーされたソース文字列と終端の null 文字を考慮するために 、pszSrc の長さに 1 を加えた値と等しい必要があります。 使用できる最大文字数は STRSAFE_MAX_CCH。

[in] pszSrc

種類: LPCTSTR

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

[out, optional] ppszDestEnd

種類: LPTSTR*

pszDest の末尾へのポインターのアドレス。 ppszDestEnd が NULL 以外で、データがコピー先バッファーにコピーされる場合、これは文字列の末尾にある終端の null 文字を指します。

[out, optional] pcchRemaining

種類: size_t*

pszDest の未使用文字の数 (終端の null 文字を含む)。 pcchRemaining が 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 値を返します。

注釈

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

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

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

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

文字列型 (String) リテラル文字列 機能
char "string" StringCchCopyExA
TCHAR TEXT("string") StringCchCopyEx
Wchar L"string" StringCchCopyExW
 

注意

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

要件

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

関連項目

参照

StringCbCopyEx

StringCchCopy