java.lang.Object
- de.ibapl.jnhw.winapi.Winbase

@Include("WinBase.h")
public abstract class Winbase
extends Object

Wrapper around the winbase.h header.

Author:: aploese

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`Winbase.COMMTIMEOUTS`	WIN: `structure COMMTIMEOUTS`.
`static class`	`Winbase.COMSTAT`	WIN: `structure COMSTAT`.
`static class`	`Winbase.DCB`	WIN: `structure DCB`.

Field Summary

Fields
Modifier and Type	Field	Description
`static byte`	`CE_BREAK`	CE_BREAK The hardware detected a break condition.
`static byte`	`CE_FRAME`	CE_FRAME The hardware detected a framing error.
`static byte`	`CE_OVERRUN`	CE_OVERRUN A character-buffer overrun has occurred.
`static byte`	`CE_RXOVER`	CE_RXOVER An input buffer overflow has occurred.
`static byte`	`CE_RXPARITY`	CE_RXPARITY The hardware detected a parity error.
`static int`	`CLRBREAK`	CLRBREAK Restores character transmission and places the transmission line in a nonbreak state.
`static int`	`CLRDTR`	CLRDTR Clears the DTR (data-terminal-ready) signal.
`static int`	`CLRRTS`	CLRRTS Clears the RTS (request-to-send) signal.
`static byte`	`DTR_CONTROL_DISABLE`	DTR_CONTROL_DISABLE Disables the DTR line when the device is opened and leaves it disabled.
`static byte`	`DTR_CONTROL_ENABLE`	DTR_CONTROL_ENABLE Enables the DTR line when the device is opened and leaves it on.
`static byte`	`DTR_CONTROL_HANDSHAKE`	DTR_CONTROL_HANDSHAKE Enables DTR handshaking.
`static byte`	`EVENPARITY`	EVENPARITY Even parity.
`static int`	`FILE_ATTRIBUTE_ARCHIVE`	FILE_ATTRIBUTE_ARCHIVE The file should be archived.
`static int`	`FILE_ATTRIBUTE_ENCRYPTED`	FILE_ATTRIBUTE_ENCRYPTED The file or directory is encrypted.
`static int`	`FILE_ATTRIBUTE_HIDDEN`	FILE_ATTRIBUTE_HIDDEN The file is hidden.
`static int`	`FILE_ATTRIBUTE_NORMAL`	FILE_ATTRIBUTE_NORMAL The file does not have other attributes set.
`static int`	`FILE_ATTRIBUTE_OFFLINE`	FILE_ATTRIBUTE_OFFLINE The data of a file is not immediately available.
`static int`	`FILE_ATTRIBUTE_READONLY`	FILE_ATTRIBUTE_READONLY The file is read only.
`static int`	`FILE_ATTRIBUTE_SYSTEM`	FILE_ATTRIBUTE_SYSTEM The file is part of or used exclusively by an operating system.
`static int`	`FILE_ATTRIBUTE_TEMPORARY`	FILE_ATTRIBUTE_TEMPORARY The file is being used for temporary storage.
`static int`	`FILE_FLAG_BACKUP_SEMANTICS`	FILE_FLAG_BACKUP_SEMANTICS The file is being opened or created for a backup or restore operation.
`static int`	`FILE_FLAG_DELETE_ON_CLOSE`	FILE_FLAG_DELETE_ON_CLOSE The file is to be deleted immediately after all of its handles are closed, which includes the specified handle and any other open or duplicated handles.
`static int`	`FILE_FLAG_NO_BUFFERING`	FILE_FLAG_NO_BUFFERING The file or device is being opened with no system caching for data reads and writes.
`static int`	`FILE_FLAG_OPEN_NO_RECALL`	FILE_FLAG_OPEN_NO_RECALL The file data is requested, but it should continue to be located in remote storage.
`static int`	`FILE_FLAG_OPEN_REPARSE_POINT`	FILE_FLAG_OPEN_REPARSE_POINT Normal reparse point processing will not occur; CreateFile will attempt to open the reparse point.
`static int`	`FILE_FLAG_OVERLAPPED`	FILE_FLAG_OVERLAPPED The file or device is being opened or created for asynchronous I/O.
`static int`	`FILE_FLAG_POSIX_SEMANTICS`	FILE_FLAG_POSIX_SEMANTICS Access will occur according to POSIX rules.
`static int`	`FILE_FLAG_RANDOM_ACCESS`	FILE_FLAG_RANDOM_ACCESS Access is intended to be random.
`static int`	`FILE_FLAG_SEQUENTIAL_SCAN`	FILE_FLAG_SEQUENTIAL_SCAN Access is intended to be sequential from beginning to end.
`static int`	`FILE_FLAG_SESSION_AWARE`	FILE_FLAG_SESSION_AWARE The file or device is being opened with session awareness.
`static int`	`FILE_FLAG_WRITE_THROUGH`	FILE_FLAG_WRITE_THROUGH Write operations will not go through any intermediate cache, they will go directly to disk.
`static byte`	`FILE_SKIP_COMPLETION_PORT_ON_SUCCESS`	FILE_SKIP_COMPLETION_PORT_ON_SUCCESS If some conditions are true, the I/O Manager does not queue a completion entry to the port, when it would ordinarily do so.
`static byte`	`FILE_SKIP_SET_EVENT_ON_HANDLE`	FILE_SKIP_SET_EVENT_ON_HANDLE The I/O Manager does not set the event for the file object if a request returns with a success code, or the error returned is ERROR_PENDING and the function that is called is not a synchronous function.
`static boolean`	`HAVE_WINBASE_H`
`static int`	`INFINITE`
`static byte`	`MARKPARITY`	MARKPARITY Mark parity.
`static int`	`MAXIMUM_WAIT_OBJECTS`	MAXIMUM_WAIT_OBJECTS The state of the specified object is signaled.
`static int`	`MS_CTS_ON`	MS_CTS_ON The CTS (clear-to-send) signal is on.
`static int`	`MS_DSR_ON`	MS_DSR_ON The DSR (data-set-ready) signal is on.
`static int`	`MS_RING_ON`	MS_RING_ON The ring indicator signal is on.
`static int`	`MS_RLSD_ON`	MS_RLSD_ON The RLSD (receive-line-signal-detect) signal is on.
`static byte`	`NOPARITY`	NOPARITY No parity.
`static byte`	`ODDPARITY`	ODDPARITY Odd parity.
`static byte`	`ONE5STOPBITS`	ONE5STOPBITS 1.5 stop bits.
`static byte`	`ONESTOPBIT`	ONESTOPBIT 1 stop bit.
`static byte`	`RTS_CONTROL_DISABLE`	RTS_CONTROL_DISABLE Disables the RTS line when the device is opened and leaves it disabled.
`static byte`	`RTS_CONTROL_ENABLE`	RTS_CONTROL_ENABLE Enables the RTS line when the device is opened and leaves it on.
`static byte`	`RTS_CONTROL_HANDSHAKE`	RTS_CONTROL_HANDSHAKE Enables RTS handshaking.
`static byte`	`RTS_CONTROL_TOGGLE`	RTS_CONTROL_TOGGLE Specifies that the RTS line will be high if bytes are available for transmission.
`static int`	`SECURITY_ANONYMOUS`	SECURITY_ANONYMOUS Impersonates a client at the Anonymous impersonation level.
`static int`	`SECURITY_CONTEXT_TRACKING`	SECURITY_CONTEXT_TRACKING he security tracking mode is dynamic.
`static int`	`SECURITY_DELEGATION`	SECURITY_DELEGATION Impersonates a client at the Delegation impersonation level.
`static int`	`SECURITY_EFFECTIVE_ONLY`	SECURITY_EFFECTIVE_ONLY Only the enabled aspects of the client's security context are available to the server.
`static int`	`SECURITY_IDENTIFICATION`	SECURITY_IDENTIFICATION Impersonates a client at the Identification impersonation level.
`static int`	`SECURITY_IMPERSONATION`	SECURITY_IMPERSONATION Impersonate a client at the impersonation level.
`static int`	`SETBREAK`	SETBREAK Suspends character transmission and places the transmission line in a break state until the ClearCommBreak function is called (or EscapeCommFunction is called with the CLRBREAK extended function code).
`static int`	`SETDTR`	SETDTR Sends the DTR (data-terminal-ready) signal.
`static int`	`SETRTS`	SETRTS Sends the RTS (request-to-send) signal.
`static int`	`SETXOFF`	SETXOFF Causes transmission to act as if an XOFF character has been received.
`static int`	`SETXON`	SETXON Causes transmission to act as if an XON character has been received.
`static byte`	`SPACEPARITY`	SPACEPARITY Space parity.
`static int`	`STD_ERROR_HANDLE`	STD_ERROR_HANDLE The standard error device.
`static int`	`STD_INPUT_HANDLE`	STD_INPUT_HANDLE The standard input device.
`static int`	`STD_OUTPUT_HANDLE`	STD_OUTPUT_HANDLE The standard output device.
`static byte`	`TWOSTOPBITS`	TWOSTOPBITS 2 stop bits.
`static int`	`WAIT_ABANDONED`	WAIT_ABANDONED
`static int`	`WAIT_FAILED`	WAIT_FAILED The specified object is a mutex object that was not released by the thread that owned the mutex object before the owning thread terminated.
`static int`	`WAIT_IO_COMPLETION`	WAIT_IO_COMPLETION The state of the specified object is signaled.
`static int`	`WAIT_OBJECT_0`	WAIT_OBJECT_0 The state of the specified object is signaled.
`static int`	`WAIT_TIMEOUT`	WAIT_TIMEOUT The time-out interval elapsed, and the object's state is nonsignaled.

Constructor Summary

Constructors
Constructor Description

Winbase()

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static void`	`BindIoCompletionCallback(Winnt.HANDLE FileHandle, Minwinbase.LPOVERLAPPED_COMPLETION_ROUTINE Function, int Flags)`	* BindIoCompletionCallback Associates the I/O completion port owned by the thread pool with the specified file handle.
`static void`	`ClearCommBreak(Winnt.HANDLE hFile)`	ClearCommBreak Restores character transmission for a specified communications device and places the transmission line in a nonbreak state.
`static void`	`ClearCommError(Winnt.HANDLE hFile, IntRef lpErrors, Winbase.COMSTAT lpStat)`	ClearCommError Retrieves information about a communications error and reports the current status of a communications device.
`static void`	`EscapeCommFunction(Winnt.HANDLE hFile, int dwFunc)`	EscapeCommFunction Directs the specified communications device to perform an extended function.
`static void`	`GetCommModemStatus(Winnt.HANDLE hFile, IntRef lpModemStat)`	GetCommModemStatus Directs the specified communications device to perform an extended function.
`static void`	`GetCommState(Winnt.HANDLE hFile, Winbase.DCB lpDCB)`	GetCommState Retrieves the current control settings for a specified communications device.
`static void`	`GetCommTimeouts(Winnt.HANDLE hFile, Winbase.COMMTIMEOUTS lpCommTimeouts)`	GetCommTimeouts Retrieves the time-out parameters for all read and write operations on a specified communications device.
`static void`	`SetCommBreak(Winnt.HANDLE hFile)`	SetCommBreak Suspends character transmission for a specified communications device and places the transmission line in a break state until the ClearCommBreak function is called.
`static void`	`SetCommState(Winnt.HANDLE hFile, Winbase.DCB lpDCB)`	SetCommState Configures a communications device according to the specifications in a device-control block (a `Winbase.DCB` structure).
`static void`	`SetCommTimeouts(Winnt.HANDLE hFile, Winbase.COMMTIMEOUTS lpCommTimeouts)`	SetCommTimeouts Sets the time-out parameters for all read and write operations on a specified communications device.
`static void`	`SetFileCompletionNotificationModes(Winnt.HANDLE hFile, byte uFlags)`	SetFileCompletionNotificationModes Sets the notification modes for a file handle, allowing you to specify how completion notifications work for the specified file.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - FILE_SKIP_SET_EVENT_ON_HANDLE
```
@Define
public static final byte FILE_SKIP_SET_EVENT_ON_HANDLE
```
    FILE_SKIP_SET_EVENT_ON_HANDLE The I/O Manager does not set the event for the file object if a request returns with a success code, or the error returned is ERROR_PENDING and the function that is called is not a synchronous function.
  - FILE_SKIP_COMPLETION_PORT_ON_SUCCESS
```
@Define
public static final byte FILE_SKIP_COMPLETION_PORT_ON_SUCCESS
```
    FILE_SKIP_COMPLETION_PORT_ON_SUCCESS If some conditions are true, the I/O Manager does not queue a completion entry to the port, when it would ordinarily do so.
  - CE_BREAK
```
@Define
public static final byte CE_BREAK
```
    CE_BREAK The hardware detected a break condition.
  - CE_FRAME
```
@Define
public static final byte CE_FRAME
```
    CE_FRAME The hardware detected a framing error.
  - CE_OVERRUN
```
@Define
public static final byte CE_OVERRUN
```
    CE_OVERRUN A character-buffer overrun has occurred. The next character is lost.
  - CE_RXOVER
```
@Define
public static final byte CE_RXOVER
```
    CE_RXOVER An input buffer overflow has occurred. There is either no room in the input buffer, or a character was received after the end-of-file (EOF) character.
  - CE_RXPARITY
```
@Define
public static final byte CE_RXPARITY
```
    CE_RXPARITY The hardware detected a parity error.
  - CLRBREAK
```
@Define
public static final int CLRBREAK
```
    CLRBREAK Restores character transmission and places the transmission line in a nonbreak state. The CLRBREAK extended function code is identical to the ClearCommBreak function.
  - CLRDTR
```
@Define
public static final int CLRDTR
```
    CLRDTR Clears the DTR (data-terminal-ready) signal.
  - CLRRTS
```
@Define
public static final int CLRRTS
```
    CLRRTS Clears the RTS (request-to-send) signal.
  - DTR_CONTROL_DISABLE
```
@Define
public static final byte DTR_CONTROL_DISABLE
```
    DTR_CONTROL_DISABLE Disables the DTR line when the device is opened and leaves it disabled.
  - DTR_CONTROL_ENABLE
```
@Define
public static final byte DTR_CONTROL_ENABLE
```
    DTR_CONTROL_ENABLE Enables the DTR line when the device is opened and leaves it on.
  - DTR_CONTROL_HANDSHAKE
```
@Define
public static final byte DTR_CONTROL_HANDSHAKE
```
    DTR_CONTROL_HANDSHAKE Enables DTR handshaking. If handshaking is enabled, it is an error for the application to adjust the line by using the EscapeCommFunction function.
  - EVENPARITY
```
@Define
public static final byte EVENPARITY
```
    EVENPARITY Even parity.
  - FILE_ATTRIBUTE_ARCHIVE
```
@Define
public static final int FILE_ATTRIBUTE_ARCHIVE
```
    FILE_ATTRIBUTE_ARCHIVE The file should be archived. Applications use this attribute to mark files for backup or removal.
  - FILE_ATTRIBUTE_ENCRYPTED
```
@Define
public static final int FILE_ATTRIBUTE_ENCRYPTED
```
    FILE_ATTRIBUTE_ENCRYPTED The file or directory is encrypted. For a file, this means that all data in the file is encrypted.
  - FILE_ATTRIBUTE_HIDDEN
```
@Define
public static final int FILE_ATTRIBUTE_HIDDEN
```
    FILE_ATTRIBUTE_HIDDEN The file is hidden. Do not include it in an ordinary directory listing.
  - FILE_ATTRIBUTE_NORMAL
```
@Define
public static final int FILE_ATTRIBUTE_NORMAL
```
    FILE_ATTRIBUTE_NORMAL The file does not have other attributes set. This attribute is valid only if used alone.
  - FILE_ATTRIBUTE_OFFLINE
```
@Define
public static final int FILE_ATTRIBUTE_OFFLINE
```
    FILE_ATTRIBUTE_OFFLINE The data of a file is not immediately available.
  - FILE_ATTRIBUTE_READONLY
```
@Define
public static final int FILE_ATTRIBUTE_READONLY
```
    FILE_ATTRIBUTE_READONLY The file is read only. Applications can read the file, but cannot write to or delete it.
  - FILE_ATTRIBUTE_SYSTEM
```
@Define
public static final int FILE_ATTRIBUTE_SYSTEM
```
    FILE_ATTRIBUTE_SYSTEM The file is part of or used exclusively by an operating system.
  - FILE_ATTRIBUTE_TEMPORARY
```
@Define
public static final int FILE_ATTRIBUTE_TEMPORARY
```
    FILE_ATTRIBUTE_TEMPORARY The file is being used for temporary storage.
  - FILE_FLAG_BACKUP_SEMANTICS
```
@Define
public static final int FILE_FLAG_BACKUP_SEMANTICS
```
    FILE_FLAG_BACKUP_SEMANTICS The file is being opened or created for a backup or restore operation.
  - FILE_FLAG_DELETE_ON_CLOSE
```
@Define
public static final int FILE_FLAG_DELETE_ON_CLOSE
```
    FILE_FLAG_DELETE_ON_CLOSE The file is to be deleted immediately after all of its handles are closed, which includes the specified handle and any other open or duplicated handles.
  - FILE_FLAG_NO_BUFFERING
```
@Define
public static final int FILE_FLAG_NO_BUFFERING
```
    FILE_FLAG_NO_BUFFERING The file or device is being opened with no system caching for data reads and writes.
  - FILE_FLAG_OPEN_NO_RECALL
```
@Define
public static final int FILE_FLAG_OPEN_NO_RECALL
```
    FILE_FLAG_OPEN_NO_RECALL The file data is requested, but it should continue to be located in remote storage.
  - FILE_FLAG_OPEN_REPARSE_POINT
```
@Define
public static final int FILE_FLAG_OPEN_REPARSE_POINT
```
    FILE_FLAG_OPEN_REPARSE_POINT Normal reparse point processing will not occur; CreateFile will attempt to open the reparse point.
  - FILE_FLAG_OVERLAPPED
```
@Define
public static final int FILE_FLAG_OVERLAPPED
```
    FILE_FLAG_OVERLAPPED The file or device is being opened or created for asynchronous I/O.
  - FILE_FLAG_POSIX_SEMANTICS
```
@Define
public static final int FILE_FLAG_POSIX_SEMANTICS
```
    FILE_FLAG_POSIX_SEMANTICS Access will occur according to POSIX rules.
  - FILE_FLAG_RANDOM_ACCESS
```
@Define
public static final int FILE_FLAG_RANDOM_ACCESS
```
    FILE_FLAG_RANDOM_ACCESS Access is intended to be random. The system can use this as a hint to optimize file caching.
  - FILE_FLAG_SEQUENTIAL_SCAN
```
@Define
public static final int FILE_FLAG_SEQUENTIAL_SCAN
```
    FILE_FLAG_SEQUENTIAL_SCAN Access is intended to be sequential from beginning to end.
  - FILE_FLAG_SESSION_AWARE
```
@Define
public static final int FILE_FLAG_SESSION_AWARE
```
    FILE_FLAG_SESSION_AWARE The file or device is being opened with session awareness.
  - FILE_FLAG_WRITE_THROUGH
```
@Define
public static final int FILE_FLAG_WRITE_THROUGH
```
    FILE_FLAG_WRITE_THROUGH Write operations will not go through any intermediate cache, they will go directly to disk.
  - SECURITY_ANONYMOUS
```
@Define
public static final int SECURITY_ANONYMOUS
```
    SECURITY_ANONYMOUS Impersonates a client at the Anonymous impersonation level.
  - SECURITY_CONTEXT_TRACKING
```
@Define
public static final int SECURITY_CONTEXT_TRACKING
```
    SECURITY_CONTEXT_TRACKING he security tracking mode is dynamic.
  - SECURITY_DELEGATION
```
@Define
public static final int SECURITY_DELEGATION
```
    SECURITY_DELEGATION Impersonates a client at the Delegation impersonation level.
  - SECURITY_EFFECTIVE_ONLY
```
@Define
public static final int SECURITY_EFFECTIVE_ONLY
```
    SECURITY_EFFECTIVE_ONLY Only the enabled aspects of the client's security context are available to the server.
  - SECURITY_IDENTIFICATION
```
@Define
public static final int SECURITY_IDENTIFICATION
```
    SECURITY_IDENTIFICATION Impersonates a client at the Identification impersonation level.
  - SECURITY_IMPERSONATION
```
@Define
public static final int SECURITY_IMPERSONATION
```
    SECURITY_IMPERSONATION Impersonate a client at the impersonation level.
  - HAVE_WINBASE_H
```
public static final boolean HAVE_WINBASE_H
```
  - INFINITE
```
@Define
public static final int INFINITE
```
  - MARKPARITY
```
@Define
public static final byte MARKPARITY
```
    MARKPARITY Mark parity.
  - MS_CTS_ON
```
@Define
public static final int MS_CTS_ON
```
    MS_CTS_ON The CTS (clear-to-send) signal is on.
  - MS_DSR_ON
```
@Define
public static final int MS_DSR_ON
```
    MS_DSR_ON The DSR (data-set-ready) signal is on.
  - MS_RING_ON
```
@Define
public static final int MS_RING_ON
```
    MS_RING_ON The ring indicator signal is on.
  - MS_RLSD_ON
```
@Define
public static final int MS_RLSD_ON
```
    MS_RLSD_ON The RLSD (receive-line-signal-detect) signal is on.
  - NOPARITY
```
@Define
public static final byte NOPARITY
```
    NOPARITY No parity.
  - ODDPARITY
```
@Define
public static final byte ODDPARITY
```
    ODDPARITY Odd parity.
  - ONE5STOPBITS
```
@Define
public static final byte ONE5STOPBITS
```
    ONE5STOPBITS 1.5 stop bits.
  - ONESTOPBIT
```
@Define
public static final byte ONESTOPBIT
```
    ONESTOPBIT 1 stop bit.
  - RTS_CONTROL_DISABLE
```
@Define
public static final byte RTS_CONTROL_DISABLE
```
    RTS_CONTROL_DISABLE Disables the RTS line when the device is opened and leaves it disabled.
  - RTS_CONTROL_ENABLE
```
@Define
public static final byte RTS_CONTROL_ENABLE
```
    RTS_CONTROL_ENABLE Enables the RTS line when the device is opened and leaves it on.
  - RTS_CONTROL_HANDSHAKE
```
@Define
public static final byte RTS_CONTROL_HANDSHAKE
```
    RTS_CONTROL_HANDSHAKE Enables RTS handshaking.
  - RTS_CONTROL_TOGGLE
```
@Define
public static final byte RTS_CONTROL_TOGGLE
```
    RTS_CONTROL_TOGGLE Specifies that the RTS line will be high if bytes are available for transmission.
  - SETBREAK
```
@Define
public static final int SETBREAK
```
    SETBREAK Suspends character transmission and places the transmission line in a break state until the ClearCommBreak function is called (or EscapeCommFunction is called with the CLRBREAK extended function code).
  - SETDTR
```
@Define
public static final int SETDTR
```
    SETDTR Sends the DTR (data-terminal-ready) signal.
  - SETRTS
```
@Define
public static final int SETRTS
```
    SETRTS Sends the RTS (request-to-send) signal.
  - SETXOFF
```
@Define
public static final int SETXOFF
```
    SETXOFF Causes transmission to act as if an XOFF character has been received.
  - SETXON
```
@Define
public static final int SETXON
```
    SETXON Causes transmission to act as if an XON character has been received.
  - SPACEPARITY
```
@Define
public static final byte SPACEPARITY
```
    SPACEPARITY Space parity.
  - STD_ERROR_HANDLE
```
@Define
public static final int STD_ERROR_HANDLE
```
    STD_ERROR_HANDLE The standard error device. Initially, this is the active console screen buffer, CONOUT$.
  - STD_INPUT_HANDLE
```
@Define
public static final int STD_INPUT_HANDLE
```
    STD_INPUT_HANDLE The standard input device. Initially, this is the console input buffer, CONIN$.
  - STD_OUTPUT_HANDLE
```
@Define
public static final int STD_OUTPUT_HANDLE
```
    STD_OUTPUT_HANDLE The standard output device. Initially, this is the active console screen buffer, CONOUT$.
  - TWOSTOPBITS
```
@Define
public static final byte TWOSTOPBITS
```
    TWOSTOPBITS 2 stop bits.
  - MAXIMUM_WAIT_OBJECTS
```
@Define
public static final int MAXIMUM_WAIT_OBJECTS
```
    MAXIMUM_WAIT_OBJECTS The state of the specified object is signaled.
  - WAIT_ABANDONED
```
@Define
public static final int WAIT_ABANDONED
```
    WAIT_ABANDONED
  - WAIT_FAILED
```
@Define
public static final int WAIT_FAILED
```
    WAIT_FAILED The specified object is a mutex object that was not released by the thread that owned the mutex object before the owning thread terminated. The function has failed. To get extended error information, call GetLastError.
    This is usually done in the native code which throws a NativeErrorExcepotion instead of passing this back.
  - WAIT_OBJECT_0
```
@Define
public static final int WAIT_OBJECT_0
```
    WAIT_OBJECT_0 The state of the specified object is signaled.
  - WAIT_IO_COMPLETION
```
@Define
public static final int WAIT_IO_COMPLETION
```
    WAIT_IO_COMPLETION The state of the specified object is signaled.
  - WAIT_TIMEOUT
```
@Define
public static final int WAIT_TIMEOUT
```
    WAIT_TIMEOUT The time-out interval elapsed, and the object's state is nonsignaled.
- Constructor Detail
  - Winbase
```
public Winbase()
```
- Method Detail
  - ClearCommBreak
```
public static final void ClearCommBreak(Winnt.HANDLE hFile)
                                 throws NativeErrorException
```
    ClearCommBreak Restores character transmission for a specified communications device and places the transmission line in a nonbreak state.
    
    Parameters:
    
    hFile - a handle to the communications device.
    
    Throws:
    
    NullPointerException - if hFile is null.
    
    NativeErrorException - if the return value of the native function indicates an error.
  - ClearCommError
```
public static final void ClearCommError(Winnt.HANDLE hFile,
                                        IntRef lpErrors,
                                        Winbase.COMSTAT lpStat)
                                 throws NativeErrorException
```
    ClearCommError Retrieves information about a communications error and reports the current status of a communications device.
    
    Parameters:
    
    hFile - a handle to the communications device.
    
    lpErrors - A pointer to a variable that receives a mask indicating the type of error. This parameter can be one or more of the following values: CE_BREAK, CE_FRAME, CE_OVERRUN, CE_RXOVER, CE_RXPARITY.
    
    lpStat - A pointer to a Winbase.COMSTAT structure in which the device's status information is returned. If this parameter is NULL, no status information is returned.
    
    Throws:
    
    NullPointerException - if hFile is null.
    
    NativeErrorException - if the return value of the native function indicates an error.
  - EscapeCommFunction
```
public static final void EscapeCommFunction(Winnt.HANDLE hFile,
                                            int dwFunc)
                                     throws NativeErrorException
```
    EscapeCommFunction Directs the specified communications device to perform an extended function.
    
    Parameters:
    
    hFile - a handle to the communications device.
    
    dwFunc - The extended function to be performed. This parameter can be one of the following values: CLRBREAK, CLRDTR, CLRRTS, SETBREAK, SETDTR, SETRTS, SETXOFF, SETXON.
    
    Throws:
    
    NullPointerException - if hFile is null.
    
    NativeErrorException - if the return value of the native function indicates an error.
  - GetCommModemStatus
```
public static final void GetCommModemStatus(Winnt.HANDLE hFile,
                                            IntRef lpModemStat)
                                     throws NativeErrorException
```
    GetCommModemStatus Directs the specified communications device to perform an extended function.
    
    Parameters:
    
    hFile - a handle to the communications device.
    
    lpModemStat - The extended function to be performed. This parameter can be one of the following values: MS_CTS_ON MS_DSR_ON MS_RING_ON MS_RLSD_ON
    
    Throws:
    
    NullPointerException - if hFile is null.
    
    NativeErrorException - if the return value of the native function indicates an error.
  - GetCommState
```
public static final void GetCommState(Winnt.HANDLE hFile,
                                      Winbase.DCB lpDCB)
                               throws NativeErrorException
```
    GetCommState Retrieves the current control settings for a specified communications device.
    
    Parameters:
    
    hFile - a handle to the communications device.
    
    lpDCB - A pointer to a Winbase.DCB structure that receives the control settings information.
    
    Throws:
    
    NullPointerException - if hFile or lpDCB is null.
    
    NativeErrorException - if the return value of the native function indicates an error.
  - GetCommTimeouts
```
public static final void GetCommTimeouts(Winnt.HANDLE hFile,
                                         Winbase.COMMTIMEOUTS lpCommTimeouts)
                                  throws NativeErrorException
```
    GetCommTimeouts Retrieves the time-out parameters for all read and write operations on a specified communications device.
    
    Parameters:
    
    hFile - a handle to the communications device.
    
    lpCommTimeouts - a pointer to a Winbase.COMMTIMEOUTS structure in which the time-out information is returned.
    
    Throws:
    
    NullPointerException - if hFile or lpCommTimeouts is null.
    
    NativeErrorException - if the return value of the native function indicates an error.
  - SetCommBreak
```
public static final void SetCommBreak(Winnt.HANDLE hFile)
                               throws NativeErrorException
```
    SetCommBreak Suspends character transmission for a specified communications device and places the transmission line in a break state until the ClearCommBreak function is called.
    
    Parameters:
    
    hFile - a handle to the communications device.
    
    Throws:
    
    NullPointerException - if hFile is null.
    
    NativeErrorException - if the return value of the native function indicates an error.
  - SetCommState
```
public static final void SetCommState(Winnt.HANDLE hFile,
                                      Winbase.DCB lpDCB)
                               throws NativeErrorException
```
    SetCommState Configures a communications device according to the specifications in a device-control block (a Winbase.DCB structure).
    
    Parameters:
    
    hFile - a handle to the communications device.
    
    lpDCB - a pointer to a Winbase.DCB structure that contains the configuration information for the specified communications device.
    
    Throws:
    
    NullPointerException - if hFile or lpDCB is null.
    
    NativeErrorException - if the return value of the native function indicates an error.
  - SetCommTimeouts
```
public static final void SetCommTimeouts(Winnt.HANDLE hFile,
                                         Winbase.COMMTIMEOUTS lpCommTimeouts)
                                  throws NativeErrorException
```
    SetCommTimeouts Sets the time-out parameters for all read and write operations on a specified communications device.
    
    Parameters:
    
    hFile - a handle to the communications device.
    
    lpCommTimeouts - a pointer to a Winbase.COMMTIMEOUTS structure that contains the new time-out values.
    
    Throws:
    
    NullPointerException - if hFile or lpCommTimeouts is null.
    
    NativeErrorException - if the return value of the native function indicates an error.
  - SetFileCompletionNotificationModes
```
public static void SetFileCompletionNotificationModes(Winnt.HANDLE hFile,
                                                      byte uFlags)
                                               throws NativeErrorException
```
    SetFileCompletionNotificationModes Sets the notification modes for a file handle, allowing you to specify how completion notifications work for the specified file.
    
    Parameters:
    
    hFile -
    
    uFlags -
    
    Throws:
    
    NativeErrorException - if the return value of the native function indicates an error.
  - BindIoCompletionCallback
```
public static void BindIoCompletionCallback(Winnt.HANDLE FileHandle,
                                            Minwinbase.LPOVERLAPPED_COMPLETION_ROUTINE Function,
                                            int Flags)
                                     throws NativeErrorException
```
    * BindIoCompletionCallback Associates the I/O completion port owned by the thread pool with the specified file handle.
    
    Parameters:
    
    FileHandle -
    
    Function -
    
    Flags -
    
    Throws:
    
    NativeErrorException - if the return value of the native function indicates an error.

Class Winbase

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FILE_SKIP_SET_EVENT_ON_HANDLE

FILE_SKIP_COMPLETION_PORT_ON_SUCCESS

CE_BREAK

CE_FRAME

CE_OVERRUN

CE_RXOVER

CE_RXPARITY

CLRBREAK

CLRDTR

CLRRTS

DTR_CONTROL_DISABLE

DTR_CONTROL_ENABLE

DTR_CONTROL_HANDSHAKE

EVENPARITY

FILE_ATTRIBUTE_ARCHIVE

FILE_ATTRIBUTE_ENCRYPTED

FILE_ATTRIBUTE_HIDDEN

FILE_ATTRIBUTE_NORMAL

FILE_ATTRIBUTE_OFFLINE

FILE_ATTRIBUTE_READONLY

FILE_ATTRIBUTE_SYSTEM

FILE_ATTRIBUTE_TEMPORARY

FILE_FLAG_BACKUP_SEMANTICS

FILE_FLAG_DELETE_ON_CLOSE

FILE_FLAG_NO_BUFFERING

FILE_FLAG_OPEN_NO_RECALL

FILE_FLAG_OPEN_REPARSE_POINT

FILE_FLAG_OVERLAPPED

FILE_FLAG_POSIX_SEMANTICS

FILE_FLAG_RANDOM_ACCESS

FILE_FLAG_SEQUENTIAL_SCAN

FILE_FLAG_SESSION_AWARE

FILE_FLAG_WRITE_THROUGH

SECURITY_ANONYMOUS

SECURITY_CONTEXT_TRACKING

SECURITY_DELEGATION

SECURITY_EFFECTIVE_ONLY

SECURITY_IDENTIFICATION

SECURITY_IMPERSONATION

HAVE_WINBASE_H

INFINITE

MARKPARITY

MS_CTS_ON

MS_DSR_ON

MS_RING_ON

MS_RLSD_ON

NOPARITY

ODDPARITY

ONE5STOPBITS

ONESTOPBIT

RTS_CONTROL_DISABLE

RTS_CONTROL_ENABLE

RTS_CONTROL_HANDSHAKE

RTS_CONTROL_TOGGLE

SETBREAK

SETDTR

SETRTS

SETXOFF

SETXON

SPACEPARITY

STD_ERROR_HANDLE

STD_INPUT_HANDLE

STD_OUTPUT_HANDLE

TWOSTOPBITS

MAXIMUM_WAIT_OBJECTS

WAIT_ABANDONED

WAIT_FAILED

WAIT_OBJECT_0

WAIT_IO_COMPLETION

WAIT_TIMEOUT

Constructor Detail

Winbase

Method Detail