ConsoleControl function

Performs special kernel operations for console host applications. This includes reparenting the console window, allowing the console to pass foreground rights on to launched console subsystem applications and terminating attached processes.

Syntax

typedef enum _CONSOLECONTROL
{
    Reserved1,
    ConsoleNotifyConsoleApplication,
    Reserved2,
    ConsoleSetCaretInfo,
    Reserved3,
    ConsoleSetForeground,
    ConsoleSetWindowOwner,
    ConsoleEndTask,
} CONSOLECONTROL;

typedef struct _CONSOLEENDTASK
{
    HANDLE ProcessId;
    HWND hwnd;
    ULONG ConsoleEventCode;
    ULONG ConsoleFlags;
} CONSOLEENDTASK, *PCONSOLEENDTASK;

typedef struct _CONSOLEWINDOWOWNER
{
    HWND hwnd;
    ULONG ProcessId;
    ULONG ThreadId;
} CONSOLEWINDOWOWNER, *PCONSOLEWINDOWOWNER;

typedef struct _CONSOLESETFOREGROUND
{
    HANDLE hProcess;
    BOOL bForeground;
} CONSOLESETFOREGROUND, *PCONSOLESETFOREGROUND;

typedef struct _CONSOLE_PROCESS_INFO
{
    IN DWORD dwProcessID;
    IN DWORD dwFlags;
} CONSOLE_PROCESS_INFO, *PCONSOLE_PROCESS_INFO;

typedef struct _CONSOLE_CARET_INFO
{
    IN HWND hwnd;
    IN RECT rc;
} CONSOLE_CARET_INFO, *PCONSOLE_CARET_INFO;


NTSTATUS ConsoleControl(
  _In_ CONSOLECONTROL Command,
  _In_reads_bytes_(ConsoleInformationLength) PVOID ConsoleInformation,
  _In_ DWORD ConsoleInformationLength
);

Parameters

Command [in]
One of the CONSOLECONTROL values indicating which console control function should be executed.

ConsoleInformation [in]
A pointer to one of the CONSOLEENDTASK, CONSOLEWINDOWOWNER, or CONSOLESETFOREGROUND structures specifying additional data for the requested console control function.

ConsoleInformationLength [in]
The size of the structure pointed to by the ConsoleInformation parameter.

Return value

If the function succeeds, the return value is STATUS_SUCCESS.

If the function fails, the return value is an NTSTATUS indicating the reason for the failure.

Remarks

This function is not defined in an SDK header and must be declared by the caller. This function is exported from user32.dll.

Each command expects a different struct for the ConsoleInformation parameter.

• ConsoleNotifyConsoleApplication: expects a pointer to a CONSOLE_PROCESS_INFO
• ConsoleSetCaretInfo: expects a pointer to a CONSOLE_CARET_INFO
• ConsoleSetForeground: expects a pointer to a CONSOLESETFOREGROUND
• ConsoleSetWindowOwner: expects a pointer to a CONSOLEWINDOWOWNER
• ConsoleEndTask: expects a pointer to a CONSOLEENDTASK

Requirements