gets
, _getws
stdin
ストリームから行を取得します。 これらの関数のセキュリティを強化したバージョンを使用できます。「gets_s
、_getws_s
」を参照してください。
重要
これらは古い関数です。 Visual Studio 2015 以降、これらは CRT で使用できません。 これらの関数のセキュリティを強化したバージョン gets_s
および _getws_s
は引き続き使用できます。 これらの代替関数の詳細については、「gets_s
, _getws_s
」を参照してください。
重要
この API は、Windows ランタイムで実行するアプリケーションでは使用できません。 詳細については、「ユニバーサル Windows プラットフォーム アプリでサポートされていない CRT 関数」を参照してください。
構文
char *gets(
char *buffer
);
wchar_t *_getws(
wchar_t *buffer
);
template <size_t size>
char *gets(
char (&buffer)[size]
); // C++ only
template <size_t size>
wchar_t *_getws(
wchar_t (&buffer)[size]
); // C++ only
パラメーター
buffer
入力文字列の格納場所。
戻り値
正常に終了した場合はその引数を返します。 エラーが発生した場合またはファイルの終端に達した場合は、 NULL
ポインターを返します。 どちらが発生したかを確認するには、ferror
または feof
を使用します。 buffer
がNULL
場合、「パラメーターの検証で説明されているように、これらの関数は無効なパラメーター ハンドラー呼び出します。 実行の継続が許可された場合、これらの関数は NULL
を返し、errno
を EINVAL
に設定します。
解説
gets
関数は、stdin
標準入力ストリームから行を読み取り、buffer
に格納します。 行は、最初の改行文字 ('\n') までのすべての文字 (改行文字を含む) で構成されます。 gets
は、行を返す前に、改行文字を null 文字 ('\0') に置き換えます。 これとは対照的に、fgets
関数は改行文字を保持します。 ワイド文字を扱う場合は、_getws
ではなく gets
を使用します。引数にはワイド文字列を指定します。また戻り値もワイド文字列です。
重要
gets
で読み取る文字の数を制限する方法がないため、信頼できない入力によってバッファー オーバーランが発生しやすくなります。 代わりに fgets
を使用してください
C++ では、これらの関数にテンプレートのオーバーロードがあります。このオーバーロードは、これらの関数に対応するセキュリティで保護された新しい関数を呼び出します。 詳細については、「セキュリティ保護されたテンプレート オーバーロード」を参照してください。
既定では、この関数のグローバル状態の適用対象は、アプリケーションになります。 この動作を変更するには、「CRT でのグローバル状態」を参照してください。
汎用テキスト ルーチンのマップ
TCHAR.H のルーチン | _UNICODE と _MBCS が定義されていない |
_MBCS が定義されている |
_UNICODE が定義されている |
---|---|---|---|
_getts |
gets |
gets |
_getws |
要件
ルーチンによって返される値 | 必須ヘッダー |
---|---|
gets |
<stdio.h> |
_getws |
<stdio.h> または <wchar.h> |
互換性の詳細については、「 Compatibility」を参照してください。
例
// crt_gets.c
// compile with: /WX /W3
#include <stdio.h>
int main( void )
{
char line[21]; // room for 20 chars + '\0'
gets( line ); // C4996
// Danger: No way to limit input to 20 chars.
// Consider using gets_s instead.
printf( "The line entered was: %s\n", line );
}
入力が 20 文字を超える場合、行バッファーがオーバーランし、ほぼ確実にプログラムがクラッシュします。
Hello there!The line entered was: Hello there!