gets_s、_getws_s

[アーティクル]
09/17/2008

更新 : 2007 年 11 月

stdin ストリームから行を取得します。これらの関数は、「CRT のセキュリティ強化」に説明されているように、gets、_getws のセキュリティが強化されたバージョンです。

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 関数は改行文字を保持します。

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

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

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

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

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

TCHAR.H のルーチン	_UNICODE および _MBCS が未定義の場合	_MBCS が定義されている場合	_UNICODE が定義されている場合
_getts	gets_s	gets_s	_getws

必要条件

ルーチン	必須ヘッダー
gets_s	<stdio.h>
_getws	<stdio.h> または <wchar.h>

互換性の詳細については、「C ランタイムライブラリ」の「互換性」を参照してください。

使用例

// 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!