WindowsNativeUtil (JavaNativeUtilsApi 4.2 API)

All Superinterfaces:: NativeUtil

public interface WindowsNativeUtil
extends NativeUtil

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`WindowsNativeUtil._locking_Mode` see https://docs.microsoft.com/en-us/cpp/c-runtime-library/reference/locking?
`static class`	`WindowsNativeUtil.CreateFileA_createMode`
`static class`	`WindowsNativeUtil.Path_VolumeName`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`String`	`__get_cpuid_count_model()` Returns the CPU Model string.
`int[]`	`__get_cpuid_count(int code, int subcode)` queries the cpu for info.
`boolean`	`_locking(int fd, WindowsNativeUtil._locking_Mode mode, long len)` returns true if successful false if not.
`Stat`	`_stat64(String path)`
`void`	`CancelIo(long handle)`
`void`	`CancelIoEx(long handle, long overlapped)`
`void`	`CancelSynchronousIo(long threadHandle)`
`void`	`CloseHandle(long handle)` Closes a windows handle.
`void`	`ConnectNamedPipe(long pipeHandle)`
`long`	`ConnectNamedPipe(long pipeHandle, long eventHandle)`
`long`	`ConvertInterfaceIndexToLuid(int idx)`
`String`	`ConvertInterfaceLuidToAlias(long luid)`
`int`	`ConvertInterfaceLuidToIndex(long luid)`
`String`	`ConvertInterfaceLuidToNameA(long luid)`
`long`	`ConvertInterfaceNameToLuidA(String name)`
`long`	`CreateEventA(long lpEventAttributes, boolean manualReset, boolean initialState, String name)` Returns a newly created event handle from the OS.
`long`	`CreateFileA(String lpFileName, int access, boolean allowDelete, boolean allowRead, boolean allowWrite, WindowsNativeUtil.CreateFileA_createMode openMode, int attributes)` opens a windows handle for a given path.
`long`	`CreateFileMappingA(long hFile, long lpFileMappingAttributes, int flProtect, int dwMaximumSizeHigh, int dwMaximumSizeLow, String lpName)` Creates a file mapping.
`long`	`CreateFileW(String lpFileName, int access, boolean allowDelete, boolean allowRead, boolean allowWrite, WindowsNativeUtil.CreateFileA_createMode openMode, int attributes)` opens a windows handle for a given path.
`void`	`CreateHardLinkA(String lpFileName, String lpExistingFileName)` Makes a hard link.
`boolean`	`CreateIpForwardEntry2(MibIpForwardRow2 entry)`
`long`	`CreateNamedPipeA(String name, int dwOpenMode, int dwPipeMode, int nMaxInstances, int nOutBufferSize, int nInBufferSize, int nDefaultTimeOut, long lpSecurityAttributes)`
`long`	`CreateSemaphoreExA(long lpSemaphoreAttributes, long initialCount, long maximumCount, String name, int dwDesiredAccess)` Create or open semaphore handle.
`void`	`CreateSymbolicLinkA(String lpSymlinkFileName, String lpTargetFileName, boolean targetIsDir, boolean isDevMode)` Makes a symbolic link.
`int`	`CTL_CODE(int DeviceType, int Function, int Method, int Access)` Helper function for CTL_CODE macro that can be used to generate the dwIoControlCode for the DeviceIoControl function.
`boolean`	`DeleteIpForwardEntry2(MibIpForwardRow2 entry)`
`int`	`DeviceIoControl(long hDevice, int dwIoControlCode, byte[] inBuffer, int inOff, int inLen, byte[] outBuffer, int outOff, int outLen)` Sends a control code directly to a specified device driver, causing the corresponding device to perform the corresponding operation.
`int`	`DeviceIoControl(long hDevice, int dwIoControlCode, NativeMemory inBuffer, long inOff, int inLen, NativeMemory outBuffer, long outOff, int outLen)` Sends a control code directly to a specified device driver, causing the corresponding device to perform the corresponding operation.
`void`	`DisconnectNamedPipe(long pipeHandle)`
`long`	`DuplicateHandle(long srcProcess, long handle, long targetProcess, int access, boolean inheritHandle, boolean closeSource, boolean sameAccess)`
`String`	`ExpandEnvironmentStringsA(String str)`
`void`	`FlushFileBuffers(long handle)`
`String`	`FormatMessageA(int lastError)` Returns a english string repesentation of the native error code This only works for all calls to methods that start with a capital case letter.
`void`	`free(long ptr)` Calls free on a pointer.
`long`	`GetAdapterIndex(String adapterName)` returns a unfriendly adapter index based on adapter name (GUID).
`Collection<IpAdapterAddresses>`	`GetAdaptersAddresses(long family, long flags)` Returns adapter addresses.
`long`	`GetCurrentProcess()` Returns a pseudo handle to the current process.
`long`	`GetCurrentThread()` Returns a pseudo Thread handle that always means current thread.
`String`	`GetEnvironmentVariableA(String name)`
`int`	`getFD(FileDescriptor fd)` Returns the int based file descriptor of the given java FileDescriptor or -1 if it is invalid.
`int`	`GetFileAttributesA(String str)`
`Win32FileAttributeData`	`GetFileAttributesEx(String path)` Returns file attributes.
`String`	`GetFinalPathNameByHandleA(long handle, boolean normalize, WindowsNativeUtil.Path_VolumeName volumeName)`
`String`	`GetFinalPathNameByHandleW(long handle, boolean normalize, WindowsNativeUtil.Path_VolumeName volumeName)`
`int`	`GetFriendlyIfIndex(long index)` Returns a friendly adapter index.
`long`	`getHandle(FileDescriptor fd)` Returns the HANDLE (void *) based file descriptor of the given java FileDescriptor or -1 (INVALID_HANDLE_VALUE) if it is invalid.
`List<MibIpForwardRow2>`	`GetIpForwardTable2(int Family)`
`String`	`GetModuleFileNameA(long hModule)`
`int`	`GetOverlappedResult(long handle, long overlapped, boolean wait)` Gets the result from an async io operation on a handle.
`int`	`getPointerSize()` Returns size of void* or windows HANDLE datatype in bytes.
`byte[]`	`GetTokenInformation(long TokenHandle, int TokenInformationClass)` Gets information about a token
`String`	`GetVolumePathNameW(String path)`
`long`	`INVALID_HANDLE_VALUE()`
`Iterable<String>`	`iterateDeviceInterfaces(GUID deviceClass, String enumerator, int flags, GUID interfaceClass)` Convenience method that uses the SetupDiGetClassDevsA+SetupDiEnumDeviceInterfaces+SetupDiGetDeviceInterfaceDetail Syscalls to provide the return value of SetupDiGetDeviceInterfaceDetail into a iterable for easier use.
`Iterable<RegEnumKeyExResult>`	`iterateRegistrySubKeys(long hkey)` Convenience method that returns an iterable over all subkeys of a hkey.
`boolean`	`LockFileEx(long handle, boolean exclusive, boolean failImmediately, long start, long len)` returns true if successful false if not.
`NativeMemory`	`malloc(long size)` Allocates a new pointer of the given size
`long`	`MapViewOfFileEx(long hFileMappingObject, int dwDesiredAccess, int dwFileOffsetHigh, int dwFileOffsetLow, int dwNumberOfBytesToMap, long lpBaseAddress)`
`long`	`OpenEventA(int desiredAccess, boolean inheritHandle, String name)`
`long`	`OpenFileMappingA(int dwDesiredAccess, boolean bInheritHandle, String lpName)` Opens an existing file mapping.
`long`	`OpenProcessToken(long ProcessHandle, int DesiredAccess)` Opens a process token handle.
`NativeMemory`	`pointer(long ptr, long size, PointerHandler handler)` Any calls to the resulting NativeMemory may cause the JVM to die due to a SEGFAULT is size is not specified correctly.
`int`	`ReadFile(long handle, byte[] buffer, int off, int len)` Reads bytes from a handle into a buffer.
`int`	`ReadFile(long handle, ByteBuffer buffer, int len)` Reads bytes from a handle into a buffer.
`int`	`ReadFile(long handle, NativeMemory buffer, long off, int len)` Reads bytes from a handle into a buffer.
`long`	`ReadFile(long handle, NativeMemory buffer, long off, int len, long overlapped, long event)` reads using overlapped mechanism. returns an overlapped pointer that must be feed by calling `free(long)` after it has been confirmed that the async READ is done by calling GetOverlappedResult.
`void`	`RegCloseKey(long hkey)`
`RegEnumKeyExResult`	`RegEnumKeyExA(long hkey, int index, int maxSubKeyLen, int maxClassLen)` Enumerate subkeys of a registry key.
`long`	`RegOpenKeyExA(long hkey, String subKey, int options, int sam)`
`RegQueryInfoKeyResult`	`RegQueryInfoKeyA(long hkey)` Get information about a registry key.
`RegData`	`RegQueryValueExA(long hkey, String valueName)` Read a registry value.
`long`	`ReleaseSemaphore(long hSemaphore, long lReleaseCount)` releases a "locked" semaphore
`void`	`ResetEvent(long handle)` Resets the given event handle.
`void`	`SetEnvironmentVariableA(String name, String value)`
`void`	`SetEvent(long handle)` Sets a event identified by the handle
`void`	`SetFileAttributesA(String str, int attr)`
`void`	`SetupDiDestroyDeviceInfoList(long handle)` Destroys a handle created by SetupDiGetClassDevsA
`SpDeviceInterfaceData`	`SetupDiEnumDeviceInterfaces(long DeviceInfoSet, SpDeviceInfoData DeviceInfoData, GUID InterfaceClassGuid, int index)` Get a device element from the device set.
`long`	`SetupDiGetClassDevsA(GUID ClassGuid, String Enumerator, long hwndParent, int flags)` Create a device enumeration for connected hardware devices.
`String`	`SetupDiGetDeviceInterfaceDetail(long DeviceInfoSet, SpDeviceInterfaceData DeviceInterfaceData, SpDeviceInfoData outputData)` Get detailed info from a device.
`long`	`ShellExecuteA(long hwnd, String lpOperation, String lpFile, String lpParameters, String lpDirectory, int nShowCmd)` Performs an operation on a specified file.
`String`	`strerror_s(int errno)` Returns a english string repesentation of the native error code.
`boolean`	`UnlockFileEx(long handle, long start, long len)` returns true if successful false if not.
`void`	`UnmapViewOfFile(long address)`
`int`	`WaitForMultipleObjects(long[] handles, int millis, boolean waitAll)` Wait for any or all event handles in a handle array.
`boolean`	`WaitForSingleObject(long handle, int millis)` Waits for a single event handle.
`boolean`	`WaitNamedPipeA(String name, long timeout)` returns true if ConnectNamedPipe will succeed.
`int`	`WriteFile(long handle, byte[] buffer, int off, int len)` Writes bytes from a Buffer into a handle.
`int`	`WriteFile(long handle, ByteBuffer buffer, int len)` Writes bytes from a Buffer into a handle.
`int`	`WriteFile(long handle, NativeMemory buffer, long off, int len)` Writes bytes from a Buffer into a handle.
`long`	`WriteFile(long handle, NativeMemory buffer, long off, int len, long overlapped, long event)` writes using overlapped mechanism. returns an overlapped pointer that must be feed by calling `free(long)` after it has been confirmed that the async WRITE is done by calling GetOverlappedResult.

Methods inherited from interface eu.aschuetz.nativeutils.api.NativeUtil
isJVM, isLinux, isNoop, isWindows

- Method Detail
  - getFD
```
int getFD(FileDescriptor fd)
```
    Returns the int based file descriptor of the given java FileDescriptor or -1 if it is invalid.
  - getHandle
```
long getHandle(FileDescriptor fd)
```
    Returns the HANDLE (void *) based file descriptor of the given java FileDescriptor or -1 (INVALID_HANDLE_VALUE) if it is invalid.
  - getPointerSize
```
int getPointerSize()
```
    Returns size of void* or windows HANDLE datatype in bytes. Either 4 or 8 bytes. The returned value is constant.
  - __get_cpuid_count
```
int[] __get_cpuid_count(int code,
                        int subcode)
```
    queries the cpu for info.
    the returned int[] is null if the requested code/subcode is not supported by the cpu otherwise it has the length of 4 and contains the registers in this oder:
    0 -> EAX
    1 -> EBX
    2 -> ECX
    3 -> EDX
    Note: on non X86/AMD64 this will always return null.
  - __get_cpuid_count_model
```
String __get_cpuid_count_model()
```
    Returns the CPU Model string. Example for Intel CPU's would be "GenuineIntel"
  - _locking
```
boolean _locking(int fd,
                 WindowsNativeUtil._locking_Mode mode,
                 long len)
          throws UnknownNativeErrorException,
                 InvalidFileDescriptorException
```
    returns true if successful false if not.
    In detail: true if _locking() returns true. false if _locking() returns false and errno is set to EACCES. any other errno leads to UnknownNativeErrorException.
    The start position the lock has will always be the current position in the file. Meaning if you want to unlock a lock you will HAVE TO move it back to position it was in when you made the lock. You have to use methods like RandomAccessFiles.seek() to accomplish this.
    
    Throws:
    
    UnknownNativeErrorException
    
    InvalidFileDescriptorException
  - LockFileEx
```
boolean LockFileEx(long handle,
                   boolean exclusive,
                   boolean failImmediately,
                   long start,
                   long len)
            throws UnknownNativeErrorException,
                   InvalidFileDescriptorException
```
    returns true if successful false if not.
    
    Throws:
    
    UnknownNativeErrorException
    
    InvalidFileDescriptorException
  - UnlockFileEx
```
boolean UnlockFileEx(long handle,
                     long start,
                     long len)
              throws UnknownNativeErrorException,
                     InvalidFileDescriptorException
```
    returns true if successful false if not.
    
    Throws:
    
    UnknownNativeErrorException
    
    InvalidFileDescriptorException
  - malloc
```
NativeMemory malloc(long size)
             throws OutOfMemoryError,
                    IllegalArgumentException
```
    Allocates a new pointer of the given size
    
    Throws:
    
    OutOfMemoryError - if malloc returns NULL
    
    IllegalArgumentException - if size is <= 0
  - free
```
void free(long ptr)
```
    Calls free on a pointer.
    
    Parameters:
    
    ptr - the pointer.
  - pointer
```
NativeMemory pointer(long ptr,
                     long size,
                     PointerHandler handler)
              throws NullPointerException
```
    Any calls to the resulting NativeMemory may cause the JVM to die due to a SEGFAULT is size is not specified correctly. the close() and sync() methods are noops.
    
    Parameters:
    
    ptr - pointer to the data
    
    size - -1 if unknown.
    
    Throws:
    
    NullPointerException
  - _stat64
```
Stat _stat64(String path)
      throws UnknownNativeErrorException,
             FileNotFoundException,
             IllegalArgumentException
```
    Throws:
    
    UnknownNativeErrorException
    
    FileNotFoundException
    
    IllegalArgumentException
  - GetFileAttributesEx
```
Win32FileAttributeData GetFileAttributesEx(String path)
                                    throws UnknownNativeErrorException
```
    Returns file attributes. Never returns null.
    
    Throws:
    
    UnknownNativeErrorException
  - CreateSymbolicLinkA
```
void CreateSymbolicLinkA(String lpSymlinkFileName,
                         String lpTargetFileName,
                         boolean targetIsDir,
                         boolean isDevMode)
                  throws UnknownNativeErrorException
```
    Makes a symbolic link. https://docs.microsoft.com/en-us/windows/win32/api/winbase/nf-winbase-createsymboliclinka
    
    Parameters:
    
    lpSymlinkFileName - The name of the symbolic link. This is where the acutal link is created
    
    lpTargetFileName - This is the name of the target where the link points to.
    
    targetIsDir - if true flag =| 0x1 is performed -> SYMBOLIC_LINK_FLAG_DIRECTORY
    
    isDevMode - if true flag =| 0x2 is poformed -> SYMBOLIC_LINK_FLAG_ALLOW_UNPRIVILEGED_CREATE according to microsoft this only works when "Developer Mode" is enabled.
    
    Throws:
    
    UnknownNativeErrorException
  - CreateHardLinkA
```
void CreateHardLinkA(String lpFileName,
                     String lpExistingFileName)
              throws UnknownNativeErrorException
```
    Makes a hard link. This does not work with directories. https://docs.microsoft.com/en-us/windows/win32/api/winbase/nf-winbase-createhardlinka
    
    Parameters:
    
    lpFileName - The name of the hard link. This is where the acutal link is created
    
    lpExistingFileName - This is the name of the target where the link points to.
    
    Throws:
    
    UnknownNativeErrorException
  - CreateFileA
```
long CreateFileA(String lpFileName,
                 int access,
                 boolean allowDelete,
                 boolean allowRead,
                 boolean allowWrite,
                 WindowsNativeUtil.CreateFileA_createMode openMode,
                 int attributes)
          throws FileAlreadyExistsException,
                 SharingViolationException,
                 UnknownNativeErrorException
```
    opens a windows handle for a given path.
    
    Parameters:
    
    lpFileName - the path to the file
    
    access - flag integer for meaning of bits see https://docs.microsoft.com/en-us/windows/win32/secauthz/access-mask
    
    allowDelete - allow another process to delete the file while it is opened by this process
    
    allowRead - allow another process to read the file while it is opened by this process
    
    allowWrite - allow another process to write the file while it is opened by this process
    
    openMode - defines how the file is opened
    
    attributes - flag integer for meaning of bits see https://docs.microsoft.com/en-us/windows/win32/fileio/file-attribute-constants
    
    Returns:
    
    valid windows HANDLE never returns INVALID_HANDLE
    
    Throws:
    
    FileAlreadyExistsException - CREATE_ALWAYS when the file already exists
    
    SharingViolationException
    
    UnknownNativeErrorException
  - CreateFileW
```
long CreateFileW(String lpFileName,
                 int access,
                 boolean allowDelete,
                 boolean allowRead,
                 boolean allowWrite,
                 WindowsNativeUtil.CreateFileA_createMode openMode,
                 int attributes)
          throws FileAlreadyExistsException,
                 SharingViolationException,
                 UnknownNativeErrorException
```
    opens a windows handle for a given path.
    
    Parameters:
    
    lpFileName - the path to the file
    
    access - flag integer for meaning of bits see https://docs.microsoft.com/en-us/windows/win32/secauthz/access-mask
    
    allowDelete - allow another process to delete the file while it is opened by this process
    
    allowRead - allow another process to read the file while it is opened by this process
    
    allowWrite - allow another process to write the file while it is opened by this process
    
    openMode - defines how the file is opened
    
    attributes - flag integer for meaning of bits see https://docs.microsoft.com/en-us/windows/win32/fileio/file-attribute-constants
    
    Returns:
    
    valid windows HANDLE never returns INVALID_HANDLE
    
    Throws:
    
    FileAlreadyExistsException - CREATE_ALWAYS when the file already exists
    
    SharingViolationException
    
    UnknownNativeErrorException
  - CreateFileMappingA
```
long CreateFileMappingA(long hFile,
                        long lpFileMappingAttributes,
                        int flProtect,
                        int dwMaximumSizeHigh,
                        int dwMaximumSizeLow,
                        String lpName)
                 throws UnknownNativeErrorException
```
    Creates a file mapping.
    
    Parameters:
    
    hFile - handle from CreateFileA/W
    
    lpFileMappingAttributes - 0 or pointer of LPSECURITY_ATTRIBUTES
    
    flProtect - 0x4 for readwrite, 0x2 for read only, 0x40 for read write execute. For other values see microsoft documentation.
    
    dwMaximumSizeHigh - high order 32 bit of the size of the mapping.
    
    dwMaximumSizeLow - low order 32 bit of the size mapping.
    
    lpName - optional global name of this mapping. If the mapping already exists then it will open that mapping instead of creating a new one.
    
    Returns:
    
    handle of the file mapping that can be closed with CloseHandle
    
    Throws:
    
    UnknownNativeErrorException
  - OpenFileMappingA
```
long OpenFileMappingA(int dwDesiredAccess,
                      boolean bInheritHandle,
                      String lpName)
               throws UnknownNativeErrorException
```
    Opens an existing file mapping.
    
    Parameters:
    
    dwDesiredAccess - desired access see WinConst.FILE_MAP_ALL_ACCESS or WinConst.FILE_MAP_WRITE among others.
    
    bInheritHandle - can a child process that is created by this process inherit this handle?
    
    lpName - name of the named file mapping.
    
    Returns:
    
    handle of the file mapping that can be closed with CloseHandle
    
    Throws:
    
    UnknownNativeErrorException
  - MapViewOfFileEx
```
long MapViewOfFileEx(long hFileMappingObject,
                     int dwDesiredAccess,
                     int dwFileOffsetHigh,
                     int dwFileOffsetLow,
                     int dwNumberOfBytesToMap,
                     long lpBaseAddress)
              throws UnknownNativeErrorException
```
    Throws:
    
    UnknownNativeErrorException
  - UnmapViewOfFile
```
void UnmapViewOfFile(long address)
              throws UnknownNativeErrorException
```
    Throws:
    
    UnknownNativeErrorException
  - CloseHandle
```
void CloseHandle(long handle)
          throws UnknownNativeErrorException,
                 InvalidFileDescriptorException
```
    Closes a windows handle. I do NOT recommend calling this with a handle that you did not create. This holds especially true for a HANDLE aquired by calling #getHandle
    
    Throws:
    
    UnknownNativeErrorException
    
    InvalidFileDescriptorException
  - iterateDeviceInterfaces
```
Iterable<String> iterateDeviceInterfaces(GUID deviceClass,
                                         String enumerator,
                                         int flags,
                                         GUID interfaceClass)
                                  throws UnknownNativeErrorException
```
    Convenience method that uses the SetupDiGetClassDevsA+SetupDiEnumDeviceInterfaces+SetupDiGetDeviceInterfaceDetail Syscalls to provide the return value of SetupDiGetDeviceInterfaceDetail into a iterable for easier use.
    
    Parameters:
    
    deviceClass - for SetupDiGetClassDevsA, can be null
    
    enumerator - for SetupDiGetClassDevsA, can be null
    
    flags - for SetupDiGetClassDevsA
    
    interfaceClass - for SetupDiEnumDeviceInterfaces, can NOT be null
    
    Throws:
    
    UnknownNativeErrorException
  - SetupDiGetClassDevsA
```
long SetupDiGetClassDevsA(GUID ClassGuid,
                          String Enumerator,
                          long hwndParent,
                          int flags)
                   throws UnknownNativeErrorException
```
    Create a device enumeration for connected hardware devices. Returns a HANDLE to the enumeration that must be destroyed by calling SetupDiDestroyDeviceInfoList
    
    Parameters:
    
    hwndParent - set to '0' for absence of a parent device class
    
    Enumerator - can be null
    
    ClassGuid - can be null
    
    Throws:
    
    UnknownNativeErrorException
  - SetupDiEnumDeviceInterfaces
```
SpDeviceInterfaceData SetupDiEnumDeviceInterfaces(long DeviceInfoSet,
                                                  SpDeviceInfoData DeviceInfoData,
                                                  GUID InterfaceClassGuid,
                                                  int index)
                                           throws UnknownNativeErrorException
```
    Get a device element from the device set.
    
    Parameters:
    
    DeviceInfoSet - obtained from SetupDiGetClassDevsA
    
    DeviceInfoData - can be null (the syscall that returns this is not yet implemented)
    
    InterfaceClassGuid - can NOT be null
    
    index - index from the set. Starts at 0, increment to iterate over the devices.
    
    Returns:
    
    an element from the set or null if there is no more data.
    
    Throws:
    
    UnknownNativeErrorException
  - SetupDiGetDeviceInterfaceDetail
```
String SetupDiGetDeviceInterfaceDetail(long DeviceInfoSet,
                                       SpDeviceInterfaceData DeviceInterfaceData,
                                       SpDeviceInfoData outputData)
```
    Get detailed info from a device.
    
    Parameters:
    
    DeviceInfoSet - obtained from SetupDiGetClassDevsA
    
    DeviceInterfaceData - obtained from SetupDiEnumDeviceInterfaces
    
    outputData - may be null if not needed. Output parameter
    
    Returns:
    
    return device path as String.
  - SetupDiDestroyDeviceInfoList
```
void SetupDiDestroyDeviceInfoList(long handle)
                           throws UnknownNativeErrorException
```
    Destroys a handle created by SetupDiGetClassDevsA
    
    Throws:
    
    UnknownNativeErrorException
  - DeviceIoControl
```
int DeviceIoControl(long hDevice,
                    int dwIoControlCode,
                    byte[] inBuffer,
                    int inOff,
                    int inLen,
                    byte[] outBuffer,
                    int outOff,
                    int outLen)
             throws UnknownNativeErrorException
```
    Sends a control code directly to a specified device driver, causing the corresponding device to perform the corresponding operation.
    
    Parameters:
    
    hDevice - device handle, probably obtained from CreateFileA with
    
    dwIoControlCode - device specific code of the operation
    
    inBuffer - input buffer, can be null
    
    outBuffer - output buffer, can be null
    
    Returns:
    
    returns the amount of bytes filled into outBuffer
    
    Throws:
    
    UnknownNativeErrorException
  - DeviceIoControl
```
int DeviceIoControl(long hDevice,
                    int dwIoControlCode,
                    NativeMemory inBuffer,
                    long inOff,
                    int inLen,
                    NativeMemory outBuffer,
                    long outOff,
                    int outLen)
             throws UnknownNativeErrorException
```
    Sends a control code directly to a specified device driver, causing the corresponding device to perform the corresponding operation.
    
    Parameters:
    
    hDevice - device handle, probably obtained from CreateFileA with
    
    dwIoControlCode - device specific code of the operation
    
    inBuffer - input buffer memory, can be null
    
    outBuffer - output buffer memory, can be null
    
    Returns:
    
    returns the amount of bytes filled into outBuffer
    
    Throws:
    
    UnknownNativeErrorException
  - CTL_CODE
```
int CTL_CODE(int DeviceType,
             int Function,
             int Method,
             int Access)
```
    Helper function for CTL_CODE macro that can be used to generate the dwIoControlCode for the DeviceIoControl function. The return value of this method is constant.
  - CreateEventA
```
long CreateEventA(long lpEventAttributes,
                  boolean manualReset,
                  boolean initialState,
                  String name)
           throws UnknownNativeErrorException
```
    Returns a newly created event handle from the OS. CloseHandle destroys this handle.
    
    Parameters:
    
    lpEventAttributes - pointer treated as LPSECURITY_ATTRIBUTES
    
    manualReset - if true then the event must be manually reset by calling ResetEvent
    
    initialState - if true then the event is initally set and must be first manually reset using ResetEvent
    
    name - name of the event, may be null.
    
    Returns:
    
    the handle to the event.
    
    Throws:
    
    UnknownNativeErrorException
  - OpenEventA
```
long OpenEventA(int desiredAccess,
                boolean inheritHandle,
                String name)
         throws UnknownNativeErrorException
```
    Throws:
    
    UnknownNativeErrorException
  - SetEvent
```
void SetEvent(long handle)
       throws UnknownNativeErrorException,
              InvalidFileDescriptorException
```
    Sets a event identified by the handle
    
    Parameters:
    
    handle -
    
    Throws:
    
    UnknownNativeErrorException
    
    InvalidFileDescriptorException
  - ResetEvent
```
void ResetEvent(long handle)
         throws UnknownNativeErrorException,
                InvalidFileDescriptorException
```
    Resets the given event handle.
    
    Throws:
    
    UnknownNativeErrorException
    
    InvalidFileDescriptorException
  - WaitForSingleObject
```
boolean WaitForSingleObject(long handle,
                            int millis)
                     throws UnknownNativeErrorException,
                            InvalidFileDescriptorException,
                            MutexAbandonedException
```
    Waits for a single event handle. Be aware that Java has no way to interrupt this call.
    
    Parameters:
    
    handle - the handle
    
    millis - timeout in millis
    
    Returns:
    
    true if the wait was successfull false on timeout
    
    Throws:
    
    UnknownNativeErrorException
    
    InvalidFileDescriptorException
    
    MutexAbandonedException
  - WaitForMultipleObjects
```
int WaitForMultipleObjects(long[] handles,
                           int millis,
                           boolean waitAll)
                    throws UnknownNativeErrorException,
                           InvalidFileDescriptorException,
                           MutexAbandonedException
```
    Wait for any or all event handles in a handle array. Be aware that Java has no way to interrupt this call.
    
    Parameters:
    
    handles - handles array. May not be null. May not be larger than 64.
    
    millis - the timeout in milliseconds.
    
    waitAll - wait for every handle in the array.
    
    Returns:
    
    the index of the handle that was sucessfully waited on. -1 for timeout. returns 0 upon success if waitAll flag is set to true.
    
    Throws:
    
    UnknownNativeErrorException
    
    InvalidFileDescriptorException
    
    MutexAbandonedException
  - strerror_s
```
String strerror_s(int errno)
```
    Returns a english string repesentation of the native error code. This only works for all calls to methods that start with "_" or lower case letters.
  - FormatMessageA
```
String FormatMessageA(int lastError)
```
    Returns a english string repesentation of the native error code This only works for all calls to methods that start with a capital case letter.
  - GetVolumePathNameW
```
String GetVolumePathNameW(String path)
                   throws UnknownNativeErrorException
```
    Throws:
    
    UnknownNativeErrorException
  - GetModuleFileNameA
```
String GetModuleFileNameA(long hModule)
                   throws UnknownNativeErrorException
```
    Throws:
    
    UnknownNativeErrorException
  - SetEnvironmentVariableA
```
void SetEnvironmentVariableA(String name,
                             String value)
                      throws UnknownNativeErrorException
```
    Throws:
    
    UnknownNativeErrorException
  - ExpandEnvironmentStringsA
```
String ExpandEnvironmentStringsA(String str)
                          throws UnknownNativeErrorException
```
    Throws:
    
    UnknownNativeErrorException
  - GetEnvironmentVariableA
```
String GetEnvironmentVariableA(String name)
                        throws UnknownNativeErrorException
```
    Throws:
    
    UnknownNativeErrorException
  - GetFinalPathNameByHandleA
```
String GetFinalPathNameByHandleA(long handle,
                                 boolean normalize,
                                 WindowsNativeUtil.Path_VolumeName volumeName)
                          throws UnknownNativeErrorException,
                                 InvalidFileDescriptorException
```
    Throws:
    
    UnknownNativeErrorException
    
    InvalidFileDescriptorException
  - GetFinalPathNameByHandleW
```
String GetFinalPathNameByHandleW(long handle,
                                 boolean normalize,
                                 WindowsNativeUtil.Path_VolumeName volumeName)
                          throws UnknownNativeErrorException,
                                 InvalidFileDescriptorException
```
    Throws:
    
    UnknownNativeErrorException
    
    InvalidFileDescriptorException
  - GetFileAttributesA
```
int GetFileAttributesA(String str)
                throws UnknownNativeErrorException
```
    Throws:
    
    UnknownNativeErrorException
  - SetFileAttributesA
```
void SetFileAttributesA(String str,
                        int attr)
                 throws UnknownNativeErrorException
```
    Throws:
    
    UnknownNativeErrorException
  - RegOpenKeyExA
```
long RegOpenKeyExA(long hkey,
                   String subKey,
                   int options,
                   int sam)
            throws UnknownNativeErrorException
```
    Throws:
    
    UnknownNativeErrorException
  - RegCloseKey
```
void RegCloseKey(long hkey)
          throws UnknownNativeErrorException
```
    Throws:
    
    UnknownNativeErrorException
  - RegQueryValueExA
```
RegData RegQueryValueExA(long hkey,
                         String valueName)
                  throws UnknownNativeErrorException
```
    Read a registry value.
    
    Parameters:
    
    hkey - the hkey obtained from RegOpenKeyExA
    
    valueName - the name of the value to read
    
    Returns:
    
    the value of the key
    
    Throws:
    
    UnknownNativeErrorException
  - RegQueryInfoKeyA
```
RegQueryInfoKeyResult RegQueryInfoKeyA(long hkey)
                                throws UnknownNativeErrorException
```
    Get information about a registry key.
    
    Throws:
    
    UnknownNativeErrorException
  - RegEnumKeyExA
```
RegEnumKeyExResult RegEnumKeyExA(long hkey,
                                 int index,
                                 int maxSubKeyLen,
                                 int maxClassLen)
                          throws UnknownNativeErrorException
```
    Enumerate subkeys of a registry key.
    
    Parameters:
    
    index - the index of the key in the enumeration microsofts documentation states that this starts at 0 and should ALWAYS be enumerated until the end (i.e. always increment this until this function returns null)
    
    maxSubKeyLen - obtained from RegQueryInfoKeyA field maxSubKeyLen If set to <= 0 then a call to RegQueryInfoKeyResult will be made internally to determine the size.
    
    maxClassLen - obtained from RegQueryInfoKeyA field maxClassLen If set to <= 0 then a call to RegQueryInfoKeyResult will be made internally to determine the size.
    
    Returns:
    
    info about the next subkey or null if there are no more subkeys.
    
    Throws:
    
    UnknownNativeErrorException
  - iterateRegistrySubKeys
```
Iterable<RegEnumKeyExResult> iterateRegistrySubKeys(long hkey)
                                             throws UnknownNativeErrorException
```
    Convenience method that returns an iterable over all subkeys of a hkey.
    
    Throws:
    
    UnknownNativeErrorException
  - GetCurrentThread
```
long GetCurrentThread()
```
    Returns a pseudo Thread handle that always means current thread. This handle cannot identify the current thread to another thread. call duplicate handle with the result of this call to get an actual thread handle!
  - GetCurrentProcess
```
long GetCurrentProcess()
```
    Returns a pseudo handle to the current process.
  - DuplicateHandle
```
long DuplicateHandle(long srcProcess,
                     long handle,
                     long targetProcess,
                     int access,
                     boolean inheritHandle,
                     boolean closeSource,
                     boolean sameAccess)
```
    Parameters:
    
    srcProcess - source process, most likely return value of GetCurrentProcess()
    
    handle - the source handle to duplicate
    
    targetProcess - target process, most likely return value of GetCurrentProcess()
    
    access - desired access flags, completely ignored if sameAccess is true
    
    inheritHandle - should child process inherit the duplicated handle?
    
    closeSource - close the source handle when "duplicating" the handle?
    
    sameAccess - use the same access flags as the source handle? true means access parameter is completely ignored.
    
    Returns:
    
    the duplicated handle
  - CancelIo
```
void CancelIo(long handle)
       throws UnknownNativeErrorException
```
    Throws:
    
    UnknownNativeErrorException
  - CancelIoEx
```
void CancelIoEx(long handle,
                long overlapped)
         throws UnknownNativeErrorException
```
    Throws:
    
    UnknownNativeErrorException
  - CancelSynchronousIo
```
void CancelSynchronousIo(long threadHandle)
                  throws UnknownNativeErrorException
```
    Throws:
    
    UnknownNativeErrorException
  - ReadFile
```
int ReadFile(long handle,
             byte[] buffer,
             int off,
             int len)
      throws InvalidFileDescriptorException,
             UnknownNativeErrorException
```
    Reads bytes from a handle into a buffer.
    
    Parameters:
    
    handle - file handle
    
    buffer - data goes here
    
    off - offset in the buffer
    
    len - maximum bytes to read
    
    Returns:
    
    number of bytes read
    
    Throws:
    
    InvalidFileDescriptorException
    
    UnknownNativeErrorException
  - ReadFile
```
int ReadFile(long handle,
             ByteBuffer buffer,
             int len)
      throws InvalidFileDescriptorException,
             UnknownNativeErrorException
```
    Reads bytes from a handle into a buffer.
    
    Parameters:
    
    handle - file handle
    
    buffer - data goes here
    
    len - maximum bytes to read
    
    Returns:
    
    number of bytes read
    
    Throws:
    
    InvalidFileDescriptorException
    
    UnknownNativeErrorException
  - ReadFile
```
int ReadFile(long handle,
             NativeMemory buffer,
             long off,
             int len)
      throws InvalidFileDescriptorException,
             UnknownNativeErrorException
```
    Reads bytes from a handle into a buffer.
    
    Parameters:
    
    handle - file handle
    
    buffer - data goes here
    
    off - offset in the buffer
    
    len - maximum bytes to read
    
    Returns:
    
    number of bytes read
    
    Throws:
    
    InvalidFileDescriptorException
    
    UnknownNativeErrorException
  - ReadFile
```
long ReadFile(long handle,
              NativeMemory buffer,
              long off,
              int len,
              long overlapped,
              long event)
       throws InvalidFileDescriptorException,
              UnknownNativeErrorException
```
    reads using overlapped mechanism. returns an overlapped pointer that must be feed by calling free(long) after it has been confirmed that the async READ is done by calling GetOverlappedResult.
    
    Parameters:
    
    event - created by CreateEventA
    
    Throws:
    
    InvalidFileDescriptorException
    
    UnknownNativeErrorException
  - WriteFile
```
int WriteFile(long handle,
              byte[] buffer,
              int off,
              int len)
       throws InvalidFileDescriptorException,
              UnknownNativeErrorException
```
    Writes bytes from a Buffer into a handle.
    
    Parameters:
    
    handle - file handle
    
    buffer - data from here
    
    off - offset of data
    
    len - maximum bytes to read
    
    Returns:
    
    number of bytes read
    
    Throws:
    
    InvalidFileDescriptorException
    
    UnknownNativeErrorException
  - WriteFile
```
int WriteFile(long handle,
              ByteBuffer buffer,
              int len)
       throws InvalidFileDescriptorException,
              UnknownNativeErrorException
```
    Writes bytes from a Buffer into a handle.
    
    Parameters:
    
    handle - file handle
    
    buffer - data from here
    
    len - maximum bytes to read
    
    Returns:
    
    number of bytes read
    
    Throws:
    
    InvalidFileDescriptorException
    
    UnknownNativeErrorException
  - WriteFile
```
int WriteFile(long handle,
              NativeMemory buffer,
              long off,
              int len)
       throws InvalidFileDescriptorException,
              UnknownNativeErrorException
```
    Writes bytes from a Buffer into a handle.
    
    Parameters:
    
    handle - file handle
    
    buffer - data from here
    
    off - offset of data
    
    len - maximum bytes to read
    
    Returns:
    
    number of bytes read
    
    Throws:
    
    InvalidFileDescriptorException
    
    UnknownNativeErrorException
  - WriteFile
```
long WriteFile(long handle,
               NativeMemory buffer,
               long off,
               int len,
               long overlapped,
               long event)
        throws InvalidFileDescriptorException,
               UnknownNativeErrorException
```
    writes using overlapped mechanism. returns an overlapped pointer that must be feed by calling free(long) after it has been confirmed that the async WRITE is done by calling GetOverlappedResult.
    
    Parameters:
    
    overlapped - pointer from a previous already completed call to this function. May be 0.
    
    event - created by CreateEventA
    
    Returns:
    
    pointer to overlapped or input parameter overlapped if parameter was non 0.
    
    Throws:
    
    InvalidFileDescriptorException
    
    UnknownNativeErrorException
  - GetOverlappedResult
```
int GetOverlappedResult(long handle,
                        long overlapped,
                        boolean wait)
                 throws InvalidFileDescriptorException,
                        UnknownNativeErrorException
```
    Gets the result from an async io operation on a handle.
    
    Parameters:
    
    handle - handle on which the async operation is performed.
    
    overlapped - overlapped pointer returned by the call that started the async operation.
    
    wait - wait until the async operation is completed before return. false means return immediately.
    
    Returns:
    
    -1 if the async operation is not yet completed. (only if wait=false) otherwise number of bytes transfered is returned.
    
    Throws:
    
    InvalidFileDescriptorException
    
    UnknownNativeErrorException
  - GetFriendlyIfIndex
```
int GetFriendlyIfIndex(long index)
```
    Returns a friendly adapter index. Sidenote: javas NetworkInterface class uses the friendly index for its byIndex method.
    
    Parameters:
    
    index - the "unfriendly" adapter index
  - GetAdapterIndex
```
long GetAdapterIndex(String adapterName)
              throws UnknownNativeErrorException
```
    returns a unfriendly adapter index based on adapter name (GUID).
    
    Parameters:
    
    adapterName - this is a GUID. YOU DO NOT SEE THIS NAME ANYWHERE OUTSIDE THE WINDOWS REGISTRY! for example: Computer\HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Class\{4d36e972-e325-11ce-bfc1-08002be10318}\0000->NetCfgInstanceId would hold this GUID. Ex value would be "{4E27A816-B07C-48E3-9453-6145B1BFFB51}"
    
    Throws:
    
    UnknownNativeErrorException
  - GetAdaptersAddresses
```
Collection<IpAdapterAddresses> GetAdaptersAddresses(long family,
                                                    long flags)
                                             throws UnknownNativeErrorException
```
    Returns adapter addresses.
    
    Throws:
    
    UnknownNativeErrorException
  - OpenProcessToken
```
long OpenProcessToken(long ProcessHandle,
                      int DesiredAccess)
               throws UnknownNativeErrorException
```
    Opens a process token handle.
    
    Returns:
    
    the token handle that must be closed with CloseHandle
    
    Throws:
    
    UnknownNativeErrorException
  - GetTokenInformation
```
byte[] GetTokenInformation(long TokenHandle,
                           int TokenInformationClass)
                    throws UnknownNativeErrorException
```
    Gets information about a token
    
    Parameters:
    
    TokenHandle - obtained from OpenProcessToken(long, int)
    
    TokenInformationClass - int constants from WinConst, all valid values start with "Token"
    
    Returns:
    
    binary struct that has to be parsed. Length/Meaning depends on TokenInformationClass
    
    Throws:
    
    UnknownNativeErrorException
  - ShellExecuteA
```
long ShellExecuteA(long hwnd,
                   String lpOperation,
                   String lpFile,
                   String lpParameters,
                   String lpDirectory,
                   int nShowCmd)
            throws ShellExecuteException
```
    Performs an operation on a specified file.
    
    Parameters:
    
    hwnd - handle to parent window. 0 is a possible value.
    
    lpOperation - operation to perform. This is a string enum. noteable values are "runas" "open" "print" and "explore"
    
    lpFile - the file to perform the operation on
    
    lpParameters - dependant on verb. on "runas" for example this would be parameters to the program pointed to by lpFile
    
    lpDirectory - defines the working directory for the action
    
    nShowCmd - defines how to action is displayed to the user value from 0 to 11 are valid
    
    Throws:
    
    ShellExecuteException
  - INVALID_HANDLE_VALUE
```
long INVALID_HANDLE_VALUE()
```
  - CreateNamedPipeA
```
long CreateNamedPipeA(String name,
                      int dwOpenMode,
                      int dwPipeMode,
                      int nMaxInstances,
                      int nOutBufferSize,
                      int nInBufferSize,
                      int nDefaultTimeOut,
                      long lpSecurityAttributes)
               throws UnknownNativeErrorException
```
    Throws:
    
    UnknownNativeErrorException
  - ConnectNamedPipe
```
void ConnectNamedPipe(long pipeHandle)
               throws UnknownNativeErrorException
```
    Throws:
    
    UnknownNativeErrorException
  - ConnectNamedPipe
```
long ConnectNamedPipe(long pipeHandle,
                      long eventHandle)
               throws UnknownNativeErrorException
```
    Parameters:
    
    eventHandle - created by CreateEventA
    
    Returns:
    
    a pointer to overlapped. Must be freed by calling free once it is confirmed that the async IO is done.
    
    Throws:
    
    UnknownNativeErrorException
  - WaitNamedPipeA
```
boolean WaitNamedPipeA(String name,
                       long timeout)
                throws UnknownNativeErrorException
```
    returns true if ConnectNamedPipe will succeed. False if timeout occured. Throws exception on any other error.
    
    Parameters:
    
    name - pipe name
    
    timeout - in millis. 0 to use default timeout of the pipe.
    
    Throws:
    
    UnknownNativeErrorException
  - DisconnectNamedPipe
```
void DisconnectNamedPipe(long pipeHandle)
                  throws UnknownNativeErrorException
```
    Throws:
    
    UnknownNativeErrorException
  - FlushFileBuffers
```
void FlushFileBuffers(long handle)
               throws UnknownNativeErrorException
```
    Throws:
    
    UnknownNativeErrorException
  - GetIpForwardTable2
```
List<MibIpForwardRow2> GetIpForwardTable2(int Family)
                                   throws UnknownNativeErrorException
```
    Throws:
    
    UnknownNativeErrorException
  - CreateIpForwardEntry2
```
boolean CreateIpForwardEntry2(MibIpForwardRow2 entry)
                       throws UnknownNativeErrorException
```
    Throws:
    
    UnknownNativeErrorException
  - DeleteIpForwardEntry2
```
boolean DeleteIpForwardEntry2(MibIpForwardRow2 entry)
                       throws UnknownNativeErrorException
```
    Throws:
    
    UnknownNativeErrorException
  - ConvertInterfaceIndexToLuid
```
long ConvertInterfaceIndexToLuid(int idx)
                          throws UnknownNativeErrorException
```
    Throws:
    
    UnknownNativeErrorException
  - ConvertInterfaceLuidToIndex
```
int ConvertInterfaceLuidToIndex(long luid)
                         throws UnknownNativeErrorException
```
    Throws:
    
    UnknownNativeErrorException
  - ConvertInterfaceLuidToNameA
```
String ConvertInterfaceLuidToNameA(long luid)
                            throws UnknownNativeErrorException
```
    Throws:
    
    UnknownNativeErrorException
  - ConvertInterfaceLuidToAlias
```
String ConvertInterfaceLuidToAlias(long luid)
                            throws UnknownNativeErrorException
```
    Throws:
    
    UnknownNativeErrorException
  - ConvertInterfaceNameToLuidA
```
long ConvertInterfaceNameToLuidA(String name)
                          throws UnknownNativeErrorException
```
    Throws:
    
    UnknownNativeErrorException
  - CreateSemaphoreExA
```
long CreateSemaphoreExA(long lpSemaphoreAttributes,
                        long initialCount,
                        long maximumCount,
                        String name,
                        int dwDesiredAccess)
                 throws UnknownNativeErrorException
```
    Create or open semaphore handle. Returned handle must be closed by calling CloseHandle
    
    Parameters:
    
    lpSemaphoreAttributes - treated as pointer to LPSECURITY_ATTRIBUTES. Most likely 0 should be passed!
    
    Returns:
    
    semaphore handle
    
    Throws:
    
    UnknownNativeErrorException
  - ReleaseSemaphore
```
long ReleaseSemaphore(long hSemaphore,
                      long lReleaseCount)
               throws UnknownNativeErrorException
```
    releases a "locked" semaphore
    
    Returns:
    
    value of lpPreviousCount
    
    Throws:
    
    UnknownNativeErrorException

Interface WindowsNativeUtil

Nested Class Summary

Method Summary

Methods inherited from interface eu.aschuetz.nativeutils.api.NativeUtil

Method Detail

getFD

getHandle

getPointerSize

__get_cpuid_count

__get_cpuid_count_model

_locking

LockFileEx

UnlockFileEx

malloc

free

pointer

_stat64

GetFileAttributesEx

CreateSymbolicLinkA

CreateHardLinkA

CreateFileA

CreateFileW

CreateFileMappingA

OpenFileMappingA

MapViewOfFileEx

UnmapViewOfFile

CloseHandle

iterateDeviceInterfaces

SetupDiGetClassDevsA

SetupDiEnumDeviceInterfaces

SetupDiGetDeviceInterfaceDetail

SetupDiDestroyDeviceInfoList

DeviceIoControl

DeviceIoControl

CTL_CODE

CreateEventA

OpenEventA

SetEvent

ResetEvent

WaitForSingleObject

WaitForMultipleObjects

strerror_s

FormatMessageA

GetVolumePathNameW

GetModuleFileNameA

SetEnvironmentVariableA

ExpandEnvironmentStringsA

GetEnvironmentVariableA

GetFinalPathNameByHandleA

GetFinalPathNameByHandleW

GetFileAttributesA

SetFileAttributesA

RegOpenKeyExA

RegCloseKey

RegQueryValueExA

RegQueryInfoKeyA

RegEnumKeyExA

iterateRegistrySubKeys

GetCurrentThread

GetCurrentProcess

DuplicateHandle

CancelIo

CancelIoEx

CancelSynchronousIo

ReadFile

ReadFile

ReadFile

ReadFile

WriteFile

WriteFile

WriteFile

WriteFile

GetOverlappedResult

GetFriendlyIfIndex

GetAdapterIndex

GetAdaptersAddresses

OpenProcessToken

GetTokenInformation

ShellExecuteA

INVALID_HANDLE_VALUE