Package org.lwjgl.system.windows

Class WinBase

java.lang.Object
org.lwjgl.system.windows.WinBase
public class WinBase extends Object
Native bindings to WinBase.h.

  • Field Details

  • Method Details

    • nLocalFree

      public static long nLocalFree(long _GetLastError, long hMem)
      Unsafe version of: LocalFree(java.nio.IntBuffer, long)

    • LocalFree

      public static long LocalFree(@Nullable IntBuffer _GetLastError, long hMem)
      Frees the specified local memory object and invalidates its handle.
      Parameters:
      _GetLastError - optionally returns the result of GetLastError() after this function is called
      hMem - a handle to the local memory object
      Returns:
      if the function succeeds, the return value is NULL.

      If the function fails, the return value is equal to a handle to the local memory object. To get extended error information, call GetLastError().

    • GetLastError

      public static int GetLastError()
      Retrieves the calling thread's last-error code value. The last-error code is maintained on a per-thread basis. Multiple threads do not overwrite each other's last-error code.

      LWJGL note: This function cannot be used after another JNI call to a Windows function, because the last-error code resets before that call returns. LWJGL adds a virtual output parameter to functions that may set the last-error code, which may be used to capture its value.

    • nGetModuleHandle

      public static long nGetModuleHandle(long _GetLastError, long moduleName)
      Unsafe version of: GetModuleHandle(java.nio.IntBuffer, java.nio.ByteBuffer)

    • GetModuleHandle

      public static long GetModuleHandle(@Nullable IntBuffer _GetLastError, @Nullable ByteBuffer moduleName)
      Retrieves a module handle for the specified module. The module must have been loaded by the calling process.
      Parameters:
      _GetLastError - optionally returns the result of GetLastError() after this function is called
      moduleName - the name of the loaded module (either a .dll or .exe file). If the file name extension is omitted, the default library extension .dll is appended. The file name string can include a trailing point character (.) to indicate that the module name has no extension. The string does not have to specify a path. When specifying a path, be sure to use backslashes (\), not forward slashes (/). The name is compared (case independently) to the names of modules currently mapped into the address space of the calling process.

      If this parameter is NULL, GetModuleHandle returns a handle to the file used to create the calling process (.exe file).

    • GetModuleHandle

      public static long GetModuleHandle(@Nullable IntBuffer _GetLastError, @Nullable CharSequence moduleName)
      Retrieves a module handle for the specified module. The module must have been loaded by the calling process.
      Parameters:
      _GetLastError - optionally returns the result of GetLastError() after this function is called
      moduleName - the name of the loaded module (either a .dll or .exe file). If the file name extension is omitted, the default library extension .dll is appended. The file name string can include a trailing point character (.) to indicate that the module name has no extension. The string does not have to specify a path. When specifying a path, be sure to use backslashes (\), not forward slashes (/). The name is compared (case independently) to the names of modules currently mapped into the address space of the calling process.

      If this parameter is NULL, GetModuleHandle returns a handle to the file used to create the calling process (.exe file).

    • nGetModuleFileName

      public static int nGetModuleFileName(long _GetLastError, long hModule, long lpFilename, int nSize)
      Unsafe version of: GetModuleFileName(java.nio.IntBuffer, long, java.nio.ByteBuffer)
      Parameters:
      nSize - the size of the lpFilename buffer, in TCHARs.

    • GetModuleFileName

      public static int GetModuleFileName(@Nullable IntBuffer _GetLastError, long hModule, ByteBuffer lpFilename)
      Retrieves the fully qualified path for the file that contains the specified module. The module must have been loaded by the current process.
      Parameters:
      _GetLastError - optionally returns the result of GetLastError() after this function is called
      hModule - a handle to the loaded module whose path is being requested.

      If this parameter is NULL, GetModuleFileName retrieves the path of the executable file of the current process.

      lpFilename - a pointer to a buffer that receives the fully qualified path of the module.

      If the length of the path is less than the size that the nSize parameter specifies, the function succeeds and the path is returned as a null-terminated string.

      If the length of the path exceeds the size that the nSize parameter specifies, the function succeeds and the string is truncated to nSize characters including the terminating null character.

      The string returned will use the same format that was specified when the module was loaded. Therefore, the path can be a long or short file name, and can use the prefix "\?".

      Returns:
      if the function succeeds, the return value is the length of the string that is copied to the buffer, in characters, not including the terminating null character.

      If the buffer is too small to hold the module name, the string is truncated to nSize characters including the terminating null character, the function returns nSize, and the function sets the last error to ERROR_INSUFFICIENT_BUFFER.

      If the function fails, the return value is 0 (zero). To get extended error information, call GetLastError().

    • GetModuleFileName

      public static String GetModuleFileName(@Nullable IntBuffer _GetLastError, long hModule, int nSize)
      Retrieves the fully qualified path for the file that contains the specified module. The module must have been loaded by the current process.
      Parameters:
      _GetLastError - optionally returns the result of GetLastError() after this function is called
      hModule - a handle to the loaded module whose path is being requested.

      If this parameter is NULL, GetModuleFileName retrieves the path of the executable file of the current process.

      nSize - the size of the lpFilename buffer, in TCHARs.
      Returns:
      if the function succeeds, the return value is the length of the string that is copied to the buffer, in characters, not including the terminating null character.

      If the buffer is too small to hold the module name, the string is truncated to nSize characters including the terminating null character, the function returns nSize, and the function sets the last error to ERROR_INSUFFICIENT_BUFFER.

      If the function fails, the return value is 0 (zero). To get extended error information, call GetLastError().

    • nLoadLibrary

      public static long nLoadLibrary(long _GetLastError, long name)
      Unsafe version of: LoadLibrary(java.nio.IntBuffer, java.nio.ByteBuffer)

    • LoadLibrary

      public static long LoadLibrary(@Nullable IntBuffer _GetLastError, ByteBuffer name)
      Loads the specified module into the address space of the calling process. The specified module may cause other modules to be loaded.
      Parameters:
      _GetLastError - optionally returns the result of GetLastError() after this function is called
      name - the name of the module. This can be either a library module (a .dll file) or an executable module (an .exe file). The name specified is the file name of the module and is not related to the name stored in the library module itself, as specified by the LIBRARY keyword in the module-definition (.def) file.

      If the string specifies a full path, the function searches only that path for the module.

      If the string specifies a relative path or a module name without a path, the function uses a standard search strategy to find the module.

      If the function cannot find the module, the function fails. When specifying a path, be sure to use backslashes (\), not forward slashes (/).

      If the string specifies a module name without a path and the file name extension is omitted, the function appends the default library extension .dll to the module name. To prevent the function from appending .dll to the module name, include a trailing point character (.) in the module name string.

    • LoadLibrary

      public static long LoadLibrary(@Nullable IntBuffer _GetLastError, CharSequence name)
      Loads the specified module into the address space of the calling process. The specified module may cause other modules to be loaded.
      Parameters:
      _GetLastError - optionally returns the result of GetLastError() after this function is called
      name - the name of the module. This can be either a library module (a .dll file) or an executable module (an .exe file). The name specified is the file name of the module and is not related to the name stored in the library module itself, as specified by the LIBRARY keyword in the module-definition (.def) file.

      If the string specifies a full path, the function searches only that path for the module.

      If the string specifies a relative path or a module name without a path, the function uses a standard search strategy to find the module.

      If the function cannot find the module, the function fails. When specifying a path, be sure to use backslashes (\), not forward slashes (/).

      If the string specifies a module name without a path and the file name extension is omitted, the function appends the default library extension .dll to the module name. To prevent the function from appending .dll to the module name, include a trailing point character (.) in the module name string.

    • nGetProcAddress

      public static long nGetProcAddress(long _GetLastError, long handle, long name)
      Unsafe version of: GetProcAddress(java.nio.IntBuffer, long, java.nio.ByteBuffer)

    • GetProcAddress

      public static long GetProcAddress(@Nullable IntBuffer _GetLastError, long handle, ByteBuffer name)
      Retrieves the address of an exported function or variable from the specified dynamic-link library (DLL).
      Parameters:
      _GetLastError - optionally returns the result of GetLastError() after this function is called
      handle - a handle to the DLL module that contains the function or variable
      name - the function or variable name, or the function's ordinal value. If this parameter is an ordinal value, it must be in the low-order word; the high-order word must be zero.

    • GetProcAddress

      public static long GetProcAddress(@Nullable IntBuffer _GetLastError, long handle, CharSequence name)
      Retrieves the address of an exported function or variable from the specified dynamic-link library (DLL).
      Parameters:
      _GetLastError - optionally returns the result of GetLastError() after this function is called
      handle - a handle to the DLL module that contains the function or variable
      name - the function or variable name, or the function's ordinal value. If this parameter is an ordinal value, it must be in the low-order word; the high-order word must be zero.

    • nFreeLibrary

      public static int nFreeLibrary(long _GetLastError, long handle)
      Unsafe version of: FreeLibrary(java.nio.IntBuffer, long)

    • FreeLibrary

      public static boolean FreeLibrary(@Nullable IntBuffer _GetLastError, long handle)
      Frees the loaded dynamic-link library (DLL) module and, if necessary, decrements its reference count. When the reference count reaches zero, the module is unloaded from the address space of the calling process and the handle is no longer valid.
      Parameters:
      _GetLastError - optionally returns the result of GetLastError() after this function is called
      handle - a handle to the loaded library module