GetConsoleHistoryInfo 関数

重要

このドキュメントでは、エコシステム ロードマップの一部ではなくなったコンソール プラットフォームの機能について説明します。 このコンテンツを新しい製品で使用することはお勧めしませんが、今後も既存の使用をサポートし続けます。 推奨される最新のソリューションでは、クロスプラットフォーム シナリオでの互換性を最大限に高める仮想ターミナル シーケンスに重点を置いています。 この設計決定の詳細については、クラシック コンソールと仮想ターミナルのドキュメントを参照してください。

呼び出しプロセスのコンソールの履歴設定を取得します。

構文

BOOL WINAPI GetConsoleHistoryInfo(
  _Out_ PCONSOLE_HISTORY_INFO lpConsoleHistoryInfo
);

パラメーター

lpConsoleHistoryInfo [out]
呼び出しプロセスのコンソールの履歴設定を取得する CONSOLE_HISTORY_INFO 構造体へのポインター。

戻り値

関数が成功すると戻り値は 0 以外になります。

関数が失敗した場合は、0 を返します。 詳細なエラー情報を得るには、GetLastError を呼び出します。

解説

呼び出し元のプロセスがコンソール プロセスでない場合、関数は失敗し、最後のエラーが ERROR_ACCESS_DENIED に設定されます。

ヒント

この API は推奨されておらず、同等の 仮想ターミナル はありません。 この決定により、Windows プラットフォームは、シェルまたはインタープリターとして動作する個々のクライアント アプリケーションが、行の読み取りやエイリアスやコマンド履歴などの操作動作などの独自のユーザー利便性の機能をメイン必要とする他のオペレーティング システムと意図的に調整されます。 この API を使用している場合、クロスプラットフォーム ユーティリティや SSH などのトランスポートを介したアプリケーションのリモート処理は、想定どおりに動作しない可能性があります。

要件

サポートされている最小のクライアント	Windows Vista [デスクトップ アプリのみ]
サポートされている最小のサーバー	Windows Server 2008 [デスクトップ アプリのみ]
ヘッダー	ConsoleApi3.h（WinCon.h 経由、Windows.h を含む）
ライブラリ	Kernel32.lib
[DLL]	Kernel32.dll

関連項目

コンソール関数

CONSOLE_HISTORY_INFO

SetConsoleHistoryInfo