StringCbGetsW 関数 (strsafe.h)

  • [アーティクル]

改行文字 ('\n') まで、stdin から 1 行のテキストを取得します。 テキスト行がコピー先バッファーにコピーされ、改行文字が null 文字に置き換えられます。 コピー先バッファーのサイズは、 関数に提供され、このバッファーの末尾を越えて書き込まれないことを確認します。

メモ この関数はインラインでのみ使用できます。
 
StringCbGets は、次の関数に代わる関数です。 StringCbGets は fget の代わりではありません。改行文字を終端の null 文字に置き換えることはありません。

構文

STRSAFEAPI StringCbGetsW(
  [out] STRSAFE_LPWSTR pszDest,
  [in]  size_t         cbDest
);

パラメーター

[out] pszDest

種類: LPTSTR

入力を受け取る宛先バッファー。

[in] cbDest

種類: size_t

コピー先バッファーのサイズ (バイト単位)。 関数を成功させるには、この値を より sizeof(TCHAR) 大きくする必要があります。 許容される最大バイト数は です STRSAFE_MAX_CCH * sizeof(TCHAR)。 cbDest が小さすぎてテキスト全体を保持できる場合、データは切り捨てられます。

戻り値

種類: HRESULT

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

リターン コード 説明
S_OK
 データは stdin から読み取られ、 pszDest でバッファーにコピーされ、バッファーは null で終了しました。
STRSAFE_E_END_OF_FILE
 エラーまたはファイルの終了条件を示します。 feof または ferror を使用して、どれが発生したかを判断します。
STRSAFE_E_INVALID_PARAMETER
 cbDest の値が、許容される最大値を超えています。
STRSAFE_E_INSUFFICIENT_BUFFER
 cbDest の値はsizeof(TCHAR)以下です。
 

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

注釈

StringCbGets は、 コード内で適切なバッファー処理を行うための追加処理を提供します。 バッファー処理の不十分さは、バッファー オーバーランを伴う多くのセキュリティの問題に関係しています。 StringCbGets は 、常に 0 以外の長さの宛先バッファーを null 終了します。

pszDest の値を NULL にすることはできません。 null 文字列ポインター値の処理が必要な場合は、「 StringCbGetsEx 」を参照してください。

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

文字列型 (String) リテラル文字列 機能
char "string" StringCbGetsA
TCHAR TEXT("string") StringCbGets
Wchar L"string" StringCbGetsW
 

注意

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

要件

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

関連項目

参照

StringCbGetsEx

StringCchGets