GetConsoleTitle 関数

  • [アーティクル]

重要

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

現在のコンソール ウィンドウのタイトルを取得します。

構文

DWORD WINAPI GetConsoleTitle(
  _Out_ LPTSTR lpConsoleTitle,
  _In_  DWORD  nSize
);

パラメーター

lpConsoleTitle [out]
タイトルを含む null で終わる文字列を受信するバッファーへのポインター。 バッファーが小さすぎてタイトルを格納できない場合には、関数はタイトルの文字をバッファーに格納するのと同じ数だけ格納し、末尾は null 終端記号になります。

nSize [in]
lpConsoleTitle パラメーターが指すバッファーのサイズ (文字単位)。

戻り値

関数が成功した場合、戻り値はコンソール ウィンドウのタイトルの長さ (文字単位) です。

関数が失敗した場合、戻り値は 0 で、GetLastError はエラー コードを返します。

解説

コンソール ウィンドウのタイトルを設定するには、SetConsoleTitle 関数を使用します。 元のタイトル文字列を取得するには、GetConsoleOriginalTitle 関数を使用します。

この関数では、Unicode 文字またはコンソールの現在のコード ページの 8 ビット文字が使用されます。 コンソールのコード ページには、最初はシステムの OEM コード ページが既定で設定されます。 コンソールのコード ページを変更するには、SetConsoleCP または SetConsoleOutputCP 関数を使用します。 従来のユーザーは、chcp または mode con cp select= コマンドを使用することもできますが、それは新規の開発ではお勧めできません。

ヒント

この API は推奨されておらず、同等の 仮想ターミナル はありません。 この決定は、Windows プラットフォームを他のオペレーティング システムと意図的に調整します。 この API を使用している場合、クロスプラットフォーム ユーティリティや SSH などのトランスポートを介したアプリケーションのリモート処理は、想定どおりに動作しない可能性があります。

例

例については、「SetConsoleTitle」を参照してください。

要件

   
サポートされている最小のクライアント Windows 2000 Professional [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows 2000 Server [デスクトップ アプリのみ]
ヘッダー ConsoleApi2.h（WinCon.h 経由、Windows.h を含む）
ライブラリ Kernel32.lib
[DLL] Kernel32.dll
Unicode 名と ANSI 名 GetConsoleTitleW (Unicode) と GetConsoleTitleA (ANSI)

関連項目

コンソール関数

GetConsoleOriginalTitle

SetConsoleCP

SetConsoleOutputCP

SetConsoleTitle