gets_s, _getws_s

  • [アーティクル]

stdin ストリームから行を取得します。 これらのバージョンのgets_getws、「CRT のセキュリティ機能説明されているように、セキュリティが強化。

構文

char *gets_s(
   char *buffer,
   size_t sizeInCharacters
);
wchar_t *_getws_s(
   wchar_t *buffer,
   size_t sizeInCharacters
);

template <size_t size>
char *gets_s( char (&buffer)[size] ); // C++ only

template <size_t size>
wchar_t *_getws_s( wchar_t (&buffer)[size] ); // C++ only

パラメーター

buffer
入力文字列の格納場所。

sizeInCharacters
バッファーのサイズ。

戻り値

正常に終了した場合は buffer を返します。 エラーが発生した場合またはファイルの終端に達した場合は、 NULL ポインターを返します。 どちらが発生したかを確認するには、ferror または feof を使用します。

解説

gets_s 関数は、stdin 標準入力ストリームから行を読み取り、buffer に格納します。 行は、最初の改行文字 ('\n') までのすべての文字 (改行文字を含む) で構成されます。 gets_s では、行を返す前に、改行文字を null 文字 ('\0') に置き換えます。 これとは対照的に、fgets_s 関数は改行文字を保持します。

最初に読み取られた文字がファイルの末尾の文字の場合は、 bufferの先頭に null 文字が格納され、 NULL が返されます。

ワイド文字を扱う場合は、_getws_s ではなく gets_s を使用します。引数にはワイド文字列を指定します。また戻り値もワイド文字列です。

bufferがNULLまたはsizeInCharactersが 0 以下の場合、またはバッファーが小さすぎて入力行と null 終端記号を含めなくなる場合、これらの関数は、パラメーター検証で説明されているように、無効なパラメーター ハンドラーを呼び出します。 実行の継続が許可された場合、これらの関数は NULL を返し、errno を ERANGEに設定します。

C++ では、これらの関数の使用はテンプレートのオーバーロードによって簡素化されます。オーバーロードでは、バッファー長を自動的に推論できる (サイズの引数を指定する必要がなくなる) だけでなく、古くてセキュリティが万全ではない関数を新しく安全な関数に自動的に置き換えることができます。 詳細については、「セキュリティ保護されたテンプレート オーバーロード」を参照してください。

既定では、この関数のグローバル状態の適用対象は、アプリケーションになります。 この動作を変更するには、「CRT でのグローバル状態」を参照してください。

汎用テキスト ルーチンのマップ

TCHAR.H ルーチン _UNICODE と _MBCS が定義されていない _MBCS が定義されている _UNICODE が定義されている
_getts_s gets_s gets_s _getws_s

要件

ルーチンによって返される値 必須ヘッダー
gets_s <stdio.h>
_getws_s <stdio.h> または <wchar.h>

ユニバーサル Windows プラットフォーム (UWP) アプリではコンソールがサポートされていません。 コンソール (stdin、stdout、stderr) に関連付けられている標準ストリームのハンドルは、C ランタイム関数によって UWP アプリで使用される前に、リダイレクトする必要があります。 互換性の詳細については、「 Compatibility」を参照してください。

例

// crt_gets_s.c
// This program retrieves a string from the stdin and
// prints the same string to the console.

#include <stdio.h>

int main( void )
{
   char line[21]; // room for 20 chars + '\0'
   gets_s( line, 20 );
   printf( "The line entered was: %s\n", line );
}

Hello there!

The line entered was: Hello there!

関連項目

ストリーム入出力
gets, _getws
fgets, fgetws
fputs, fputws
puts, _putws