Package com.sun.jna.platform.win32

Interface Wincon

  • All Known Subinterfaces:
    Kernel32
    public interface Wincon
    Ported from Wincon.h.
    Author:
    lgoldstein

    • Method Detail

      • AllocConsole

        boolean AllocConsole()
        Allocates a new console for the calling process.
        Returns:
        true if successful - if false then use GetLastError() to get extended error information
        See Also:
        AllocConsole documentation

      • FreeConsole

        boolean FreeConsole()
        Detaches the calling process from its console
        Returns:
        true if successful - if false then use GetLastError() to get extended error information
        See Also:
        FreeConsole documentation

      • AttachConsole

        boolean AttachConsole​(int dwProcessId)
        Attaches the calling process to the console of the specified process
        Parameters:
        dwProcessId - The identifier of the process whose console is to be used. Can be either the process ID or the special ATTACH_PARENT_PROCESS value to indicate the console of the parent of the current process.
        Returns:
        true if successful - if false then use GetLastError() to get extended error information
        See Also:
        AttachConsole documentation

      • FlushConsoleInputBuffer

        boolean FlushConsoleInputBuffer​(WinNT.HANDLE hConsoleInput)
        Flushes the console input buffer. All input records currently in the input buffer are discarded.
        Parameters:
        hConsoleInput - A handle to the console input buffer. The handle must have the GENERIC_WRITE access right.
        Returns:
        true if successful - if false then use GetLastError() to get extended error information
        See Also:
        FlushConsoleInputBuffer documentation

      • GenerateConsoleCtrlEvent

        boolean GenerateConsoleCtrlEvent​(int dwCtrlEvent,
                                 int dwProcessGroupId)
        Sends a specified signal to a console process group that shares the console associated with the calling process.
        Parameters:
        dwCtrlEvent - The type of signal to be generated.
        dwProcessGroupId - The identifier of the process group to receive the signal
        Returns:
        true if successful - if false then use GetLastError() to get extended error information
        See Also:
        GenerateConsoleCtrlEvent documentation

      • GetConsoleCP

        int GetConsoleCP()
        Returns:
        Code that identifies the code page
        See Also:
        Code page identifiers

      • SetConsoleCP

        boolean SetConsoleCP​(int wCodePageID)
        Parameters:
        wCodePageID - The identifier of the code page to be set
        Returns:
        true if successful - if false then use GetLastError() to get extended error information
        See Also:
        SetConsoleCP documentation

      • GetConsoleOutputCP

        int GetConsoleOutputCP()
        Returns:
        Retrieves the output code page used by the console associated with the calling process.
        See Also:
        Code page identifiers

      • SetConsoleOutputCP

        boolean SetConsoleOutputCP​(int wCodePageID)
        Parameters:
        wCodePageID - The output code page used by the console associated with the calling process.
        Returns:
        true if successful - if false then use GetLastError() to get extended error information
        See Also:
        SetConsoleOutputCP documentation

      • GetConsoleWindow

        WinDef.HWND GetConsoleWindow()
        Returns:
        The window handle used by the console associated with the calling process

      • GetNumberOfConsoleInputEvents

        boolean GetNumberOfConsoleInputEvents​(WinNT.HANDLE hConsoleInput,
                                      IntByReference lpcNumberOfEvents)
        Parameters:
        hConsoleInput - A handle to the console input buffer. The handle must have the GENERIC_READ access right
        lpcNumberOfEvents - A pointer to a variable that receives the number of unread input records in the console's input buffer
        Returns:
        true if successful - if false then use GetLastError() to get extended error information
        See Also:
        GetNumberOfConsoleInputEvents documentation

      • GetNumberOfConsoleMouseButtons

        boolean GetNumberOfConsoleMouseButtons​(IntByReference lpNumberOfMouseButtons)
        Parameters:
        lpNumberOfMouseButtons - A pointer to a variable that receives the number of mouse buttons
        Returns:
        true if successful - if false then use GetLastError() to get extended error information
        See Also:
        GetNumberOfConsoleMouseButtons documentation

      • GetStdHandle

        WinNT.HANDLE GetStdHandle​(int nStdHandle)
        Parameters:
        nStdHandle - The standard device identifier
        Returns:
        A handle to the specified standard device (standard input, output, or error)

      • SetStdHandle

        boolean SetStdHandle​(int nStdHandle,
                     WinNT.HANDLE hHandle)
        Parameters:
        nStdHandle - The standard device identifier
        hHandle - The handle for the standard device
        Returns:
        true if successful - if false then use GetLastError() to get extended error information
        See Also:
        SetStdHandle documentation

      • GetConsoleDisplayMode

        boolean GetConsoleDisplayMode​(IntByReference lpModeFlags)
        Retrieves the display mode of the current console
        Parameters:
        lpModeFlags - The display mode of the console
        Returns:
        true if successful - if false then use GetLastError() to get extended error information
        See Also:
        GetConsoleDisplayMode documentation

      • GetConsoleMode

        boolean GetConsoleMode​(WinNT.HANDLE hConsoleHandle,
                       IntByReference lpMode)
        Parameters:
        hConsoleHandle - A handle to the console input buffer or the console screen buffer. The handle must have the GENERIC_READ access right
        lpMode - A pointer to a variable that receives the current mode of the specified buffer
        Returns:
        true if successful - if false then use GetLastError() to get extended error information
        See Also:
        GetConsoleMode documentation

      • SetConsoleMode

        boolean SetConsoleMode​(WinNT.HANDLE hConsoleHandle,
                       int dwMode)
        Parameters:
        hConsoleHandle - A handle to the console input buffer or a console screen buffer. The handle must have the GENERIC_READ access right
        dwMode - The input or output mode mask to be set
        Returns:
        true if successful - if false then use GetLastError() to get extended error information
        See Also:
        SetConsoleMode documentation

      • GetConsoleTitle

        int GetConsoleTitle​(char[] lpConsoleTitle,
                    int nSize)
        Parameters:
        lpConsoleTitle - A pointer to a buffer that receives a null-terminated string containing the title. If the buffer is too small to store the title, the function stores as many characters of the title as will fit in the buffer, ending with a null terminator. Note: use Native.toString(char[]) to convert it to a String value
        nSize - The size of the buffer pointed to by the lpConsoleTitle parameter, in characters.
        Returns:
        If the function succeeds, the return value is the length of the console window's title, in characters. If the function fails, the return value is zero and GetLastError returns the error code.
        See Also:
        GetConsoleTitle documentation

      • GetConsoleOriginalTitle

        int GetConsoleOriginalTitle​(char[] lpConsoleTitle,
                            int nSize)
        Parameters:
        lpConsoleTitle - A pointer to a buffer that receives a null-terminated string containing the original title. Note: use Native.toString(char[]) to convert it to a String value
        nSize - The size of the lpConsoleTitle buffer, in characters
        Returns:
        If the function succeeds, the return value is the length of the string copied to the buffer, in characters. If the buffer is not large enough to store the title, the return value is zero and GetLastError returns ERROR_SUCCESS. If the function fails, the return value is zero and GetLastError returns the error code.
        See Also:
        GetConsoleOriginalTitle documentation

      • SetConsoleTitle

        boolean SetConsoleTitle​(String lpConsoleTitle)
        Parameters:
        lpConsoleTitle - The string to be displayed in the title bar of the console window. The total size must be less than MAX_CONSOLE_TITLE_LENGTH.
        Returns:
        true if successful - if false then use GetLastError() to get extended error information
        See Also:
        SetConsoleTitle documentation

      • GetConsoleScreenBufferInfo

        boolean GetConsoleScreenBufferInfo​(WinNT.HANDLE hConsoleOutput,
                                   Wincon.CONSOLE_SCREEN_BUFFER_INFO lpConsoleScreenBufferInfo)
        Retrieves information about the specified console screen buffer.
        Parameters:
        hConsoleOutput - A handle to the console screen buffer.
        lpConsoleScreenBufferInfo - A pointer to a CONSOLE_SCREEN_BUFFER_INFO structure that receives the console screen buffer information.
        Returns:
        true if successful - if false then use GetLastError() to get extended error information
        See Also:
        GetConsoleScreenBufferInfo documentation

      • ReadConsoleInput

        boolean ReadConsoleInput​(WinNT.HANDLE hConsoleInput,
                         Wincon.INPUT_RECORD[] lpBuffer,
                         int nLength,
                         IntByReference lpNumberOfEventsRead)
        Reads data from a console input buffer and removes it from the buffer.
        Parameters:
        hConsoleInput - A handle to the console input buffer.
        lpBuffer - A pointer to an array of INPUT_RECORD structures that receives the input buffer data.
        nLength - The size of the array pointed to by the lpBuffer parameter, in array elements.
        lpNumberOfEventsRead - A pointer to a variable that receives the number of input records read.
        Returns:
        true if successful - if false then use GetLastError() to get extended error information
        See Also:
        ReadConsoleInput documentation

      • WriteConsole

        boolean WriteConsole​(WinNT.HANDLE hConsoleOutput,
                     String lpBuffer,
                     int nNumberOfCharsToWrite,
                     IntByReference lpNumberOfCharsWritten,
                     WinDef.LPVOID lpReserved)
        Writes a character string to a console screen buffer beginning at the current cursor location.
        Parameters:
        hConsoleOutput - A handle to the console screen buffer.
        lpBuffer - A pointer to a buffer that contains characters to be written to the console screen buffer.
        nNumberOfCharsToWrite - The number of characters to be written.
        lpNumberOfCharsWritten - A pointer to a variable that receives the number of characters actually written.
        lpReserved - Reserved; must be NULL.
        Returns:
        true if successful - if false then use GetLastError() to get extended error information
        See Also:
        WriteConsole documentation