次の方法で共有

StringCchCopyExW 関数 (strsafe.h)

  • [アーティクル]

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

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

StringCchCopyEx は、次の関数の代わりに使用されます。

構文

STRSAFEAPI StringCchCopyExW(
  [out]           STRSAFE_LPWSTR  pszDest,
  [in]            size_t          cchDest,
  [in]            STRSAFE_LPCWSTR pszSrc,
  [out, optional] STRSAFE_LPWSTR  *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
 空 文字列 (TEXT("")) のように NULL 文字列ポインターを扱います。 このフラグは、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 が重複 場合、動作は未定義です。

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

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

文字列データ型 文字列リテラル 機能
char を する "string" StringCchCopyExA の
TCHAR の TEXT("string") StringCchCopyEx の
WCHAR の L"string" StringCchCopyExW の
 

手記

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

必要条件

要件 価値
サポートされる最小クライアント Windows XP と SP2 [デスクトップ アプリ |UWP アプリ]
サポートされる最小サーバー Windows Server 2003 SP1 [デスクトップ アプリ |UWP アプリ]
ターゲット プラットフォーム の ウィンドウズ
ヘッダー strsafe.h

関連項目

リファレンス

StringCbCopyEx の

StringCchCopy