次の方法で共有

_cgets_s, _cgetws_s

  • [アーティクル]

コンソールから文字列を取得します。 これらのバージョンの _cgets と _cgetws には、CRT のセキュリティ機能 説明されているように、セキュリティが強化。

重要

この API は、Windows ランタイムで実行するアプリケーションでは使用できません。 詳細については、「ユニバーサル Windows プラットフォーム アプリでサポートされていない CRT 関数」を参照してください。

構文

errno_t _cgets_s(
   char *buffer,
   size_t numberOfElements,
   size_t *pSizeRead
);
errno_t _cgetws_s(
   wchar_t *buffer
   size_t numberOfElements,
   size_t *pSizeRead
);
template <size_t size>
errno_t _cgets_s(
   char (&buffer)[size],
   size_t *pSizeRead
); // C++ only
template <size_t size>
errno_t _cgetws_s(
   wchar_t (&buffer)[size],
   size_t *pSizeRead
); // C++ only

パラメーター

buffer
データの格納場所。

numberOfElements
バッファーのサイズです。単位はバイト数またワイド文字数です。これは、読み取る最大の文字数でもあります。

pSizeRead
実際に読み取った文字数。

戻り値

成功した場合の戻り値は 0 です。それ以外の場合 (エラー発生時) は、エラー コードです。

エラー条件

buffer numberOfElements pSizeRead Return buffer の内容
NULL 任意 任意 EINVAL 該当なし
NULL 以外 ゼロ 任意 EINVAL 変更されない
NULL 以外 任意 NULL EINVAL 長さゼロの文字列

解説

_cgets_s および _cgetws_s は、コンソールから文字列を読み取り、その文字列 (null で終了する) を buffer にコピーします。 _cgetws_s はこの関数のワイド文字バージョンで、文字のサイズを除いて、これら 2 つの関数の動作は同じです。 読み取る文字列の最大サイズは、numberOfElements パラメーターに入れて渡します。 このサイズには、終端の null に対応する追加の文字を含める必要があります。 実際に読み取られた文字数は、pSizeRead に置かれます。

操作中またはパラメーターの検証中にエラーが発生した場合は、「パラメーターの検証」で説明されているように、無効なパラメーター ハンドラー 呼び出。 実行を続行できる場合、 errno は EINVAL に設定され、 EINVAL が返されます。

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

これらの関数のデバッグ ライブラリ バージョンでは、最初にバッファーを 0xFE で埋めます。 この動作を無効にするには、_CrtSetDebugFillThreshold を使用します。

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

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

Tchar.h のルーチン _UNICODE と _MBCS が定義されていない _MBCS が定義されている _UNICODE が定義されている
_cgetts_s _cgets_s _cgets_s _cgetws_s

要件

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

互換性の詳細については、「 Compatibility」を参照してください。

関連項目

コンソール入出力とポート入出力
_getch, _getwch