次の方法で共有

GetConsoleOriginalTitle 関数

  • [アーティクル]

重要

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

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

構文

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

パラメーター

lpConsoleTitle [out]
元のタイトルを含む null で終わる文字列を受信するバッファーへのポインター。

nSize [in]
lpConsoleTitle バッファーのサイズ (文字単位)。

戻り値

nSize が 0 の場合、戻り値は 0 です。

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

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

解説

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

この関数を使用するアプリケーションをコンパイルするには、_WIN32_WINNT を 0x0600 以降として定義します。 詳細については、「Windows ヘッダーの使用」を参照してください。

ヒント

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

要件

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

関連項目

コンソール関数

GetConsoleTitle

SetConsoleTitle