AllocConsoleWithOptions – funkce

Volitelně přidělí novou konzolu pro volající proces a umožní vám určit viditelnost nového okna konzoly.

Syntaxe

HRESULT WINAPI AllocConsoleWithOptions(
    _In_opt_  PALLOC_CONSOLE_OPTIONS allocOptions,
    _Out_opt_ PALLOC_CONSOLE_RESULT  result
);

Parametry

allocOptions [in, volitelné] Struktura ALLOC_CONSOLE_OPTIONS , která řídí, jak tato funkce přiděluje okno.

výsledek [out, nepovinný] Obdrží jednu z následujících hodnot:

Hodnota	Význam
ALLOC_CONSOLE_RESULT_BEZ_KONZOLE 0	Nebyla vytvořena žádná konzola, protože byla použita možnost ALLOC_CONSOLE_MODE_DEFAULT a nadřazený proces nepožadoval vytvoření žádné.
ALLOC_CONSOLE_RESULT_NEW_CONSOLE 1	V důsledku tohoto volání byla vytvořena nová konzolová relace. Výsledné chování je stejné jako AllocConsole.
VÝSLEDEK_ALLOC_CONSOLE_EXISTUJÍCÍ_KONZOLA 2	Tento proces se připojil k existující relaci konzoly, kterou zdědil nadřazený proces. Výsledné chování je stejné jako AttachConsole.

Návratová hodnota

Typ: HRESULT

Pokud je tato metoda úspěšná, vrátí S_OK. V opačném případě vrátí kód chyby HRESULT.

Poznámky

Na rozdíl od AllocConsole nebo AttachConsole, volání této metody, pokud už je připojena k relaci konzoly, nemá za následek chybu. Parametr result se v takovém případě nastaví na ALLOC_CONSOLE_RESULT_EXISTING_CONSOLE.

Proces může použít funkci FreeConsole k odpojení od aktuální konzoly. Konzola se zavře, když poslední proces připojený k ní ukončí nebo zavolá FreeConsole.

Požadavky

Minimální podporovaný klient	Windows 11 24H2 (build 26100) [jenom desktopové aplikace]
Minimální podporovaný server	Windows Server 2025 (build 26100)
Záhlaví	ConsoleApi.h (přes WinCon.h, včetně Windows.h)
Knihovna	Kernel32.lib
knihovna DLL	Kernel32.dll

Viz také

Funkce konzoly

konzoly

Zásady přidělování konzoly

AllocConsole

AttachConsole

FreeConsole