GetConsoleTitleW

現在のコンソールウィンドウのタイトルとそのサイズを取得する。

GetConsoleTitleW lpConsoleTitle, nSize

lpConsoleTitle : [wstr] タイトルを含む NULL 終端文字列を受け取るバッファへのポインタ。バッファがタイトルを格納するには小さすぎる場合、関数はバッファに収まる分だけのタイトル文字を格納し、NULL 終端で締めくくる。
nSize : [int] *lpConsoleTitle* パラメータが指すバッファのサイズ。文字数で指定する。

(プラグイン / モジュール : kernel32.dll)

解説

現在のコンソールウィンドウのタイトルとそのサイズを取得する。

[戻り値]
関数が成功した場合、戻り値はコンソールウィンドウのタイトルの長さ（文字数）である。関数が失敗した場合、戻り値は 0
で、[**GetLastError**](/windows/win32/api/errhandlingapi/nf-errhandlingapi-getlasterror)
がエラーコードを返す。

[備考]
コンソールウィンドウのタイトルを設定するには [**SetConsoleTitle**](setconsoletitle.md)
関数を使う。元のタイトル文字列を取得するには
[**GetConsoleOriginalTitle**](getconsoleoriginaltitle.md)
関数を使う。[!INCLUDE
[setting-codepage-mode-remarks](./includes/setting-codepage-mode-remarks.md)]
> [!TIP] > この API は推奨されておらず、**[virtual
terminal](console-virtual-terminal-sequences.md)**
に相当するものはない。この決定は意図的に Windows プラットフォームを他の OS と整合させるためのものである。SSH
のようなクロスプラットフォームのユーティリティやトランスポートを通じてリモート接続するアプリケーションでは、この API
を使うと期待どおりに動作しないことがある。

情報