GetConsoleAliases 関数
重要
このドキュメントでは、エコシステム ロードマップの一部ではなくなったコンソール プラットフォームの機能について説明します。 このコンテンツを新しい製品で使用することはお勧めしませんが、今後も既存の使用をサポートし続けます。 推奨される最新のソリューションでは、クロスプラットフォーム シナリオでの互換性を最大限に高める仮想ターミナル シーケンスに重点を置いています。 この設計決定の詳細については、クラシック コンソールと仮想ターミナルのドキュメントを参照してください。
指定した実行可能ファイルに対して定義されているすべてのコンソール エイリアスを取得します。
構文
DWORD WINAPI GetConsoleAliases(
_Out_ LPTSTR lpAliasBuffer,
_In_ DWORD AliasBufferLength,
_In_ LPTSTR lpExeName
);
パラメーター
lpAliasBuffer [out]
エイリアスを受け取るバッファーへのポインター。
データの形式は次のとおりです。Source1=Target1\0Source2=Target2\0... SourceN=TargetN\0 (ここで N は、定義されているコンソール エイリアスの数です)。
AliasBufferLength [in]
lpAliasBuffer で指し示されるバッファーのサイズ (バイト単位)。
lpExeName [in]
エイリアスを取得する実行可能ファイル。
戻り値
関数が成功すると、戻り値は 0 以外になります。
関数が失敗した場合は、0 を返します。 詳細なエラー情報を得るには、GetLastError を呼び出します。
解説
lpExeName バッファーに必要なサイズを決定するには、GetConsoleAliasesLength 関数を使用します。
この関数を使用するアプリケーションをコンパイルするには、_WIN32_WINNT を 0x0501 以降として定義します。 詳細については、「Windows ヘッダーの使用」を参照してください。
ヒント
この API は推奨されておらず、同等の 仮想ターミナル はありません。 この決定により、Windows プラットフォームは、シェルまたはインタープリターとして動作する個々のクライアント アプリケーションが、行の読み取りやエイリアスやコマンド履歴などの操作動作などの独自のユーザー利便性の機能をメイン必要とする他のオペレーティング システムと意図的に調整されます。 この API を使用している場合、クロスプラットフォーム ユーティリティや SSH などのトランスポートを介したアプリケーションのリモート処理は、想定どおりに動作しない可能性があります。
要件
| サポートされている最小のクライアント | Windows 2000 Professional [デスクトップ アプリのみ] |
| サポートされている最小のサーバー | Windows 2000 Server [デスクトップ アプリのみ] |
| ヘッダー | ConsoleApi3.h（WinCon.h 経由、Windows.h を含む） |
| ライブラリ | Kernel32.lib |
| [DLL] | Kernel32.dll |
| Unicode 名と ANSI 名 | GetConsoleAliasesW (Unicode) と GetConsoleAliasesA (ANSI) |