|
JNA API> 4.0.0 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Kernel32
Interface definitions for kernel32.dll
. Includes additional
alternate mappings from WinNT
which make use of NIO buffers.
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface com.sun.jna.platform.win32.WinBase |
---|
WinBase.FILETIME, WinBase.MEMORYSTATUSEX, WinBase.OVERLAPPED, WinBase.PROCESS_INFORMATION, WinBase.SECURITY_ATTRIBUTES, WinBase.STARTUPINFO, WinBase.SYSTEM_INFO, WinBase.SYSTEMTIME |
Nested classes/interfaces inherited from interface com.sun.jna.platform.win32.BaseTSD |
---|
BaseTSD.DWORD_PTR, BaseTSD.LONG_PTR, BaseTSD.SIZE_T, BaseTSD.SSIZE_T, BaseTSD.ULONG_PTR, BaseTSD.ULONG_PTRByReference |
Nested classes/interfaces inherited from interface com.sun.jna.win32.StdCallLibrary |
---|
StdCallLibrary.StdCallCallback |
Nested classes/interfaces inherited from interface com.sun.jna.Library |
---|
Library.Handler |
Field Summary | |
---|---|
static Kernel32 |
INSTANCE
The instance. |
Fields inherited from interface com.sun.jna.platform.win32.WinDef |
---|
MAX_PATH |
Fields inherited from interface com.sun.jna.win32.StdCallLibrary |
---|
FUNCTION_MAPPER, STDCALL_CONVENTION |
Fields inherited from interface com.sun.jna.Library |
---|
OPTION_ALLOW_OBJECTS, OPTION_CALLING_CONVENTION, OPTION_CLASSLOADER, OPTION_FUNCTION_MAPPER, OPTION_INVOCATION_MAPPER, OPTION_OPEN_FLAGS, OPTION_STRING_ENCODING, OPTION_STRUCTURE_ALIGNMENT, OPTION_TYPE_MAPPER |
Method Summary | |
---|---|
boolean |
CloseHandle(WinNT.HANDLE hObject)
The CloseHandle function closes an open object handle. |
boolean |
CopyFile(String lpExistingFileName,
String lpNewFileName,
boolean bFailIfExists)
Copies an existing file to a new file. |
boolean |
CreateDirectory(String lpPathName,
WinBase.SECURITY_ATTRIBUTES lpSecurityAttributes)
The CreateDirectory function creates a new directory. |
WinNT.HANDLE |
CreateEvent(WinBase.SECURITY_ATTRIBUTES lpEventAttributes,
boolean bManualReset,
boolean bInitialState,
String lpName)
Creates or opens a named or unnamed event object. |
WinNT.HANDLE |
CreateFile(String lpFileName,
int dwDesiredAccess,
int dwShareMode,
WinBase.SECURITY_ATTRIBUTES lpSecurityAttributes,
int dwCreationDisposition,
int dwFlagsAndAttributes,
WinNT.HANDLE hTemplateFile)
The CreateFile function creates or opens a file, file stream, directory, physical disk, volume, console buffer, tape drive, communications resource, mailslot, or named pipe. |
WinNT.HANDLE |
CreateFileMapping(WinNT.HANDLE hFile,
WinBase.SECURITY_ATTRIBUTES lpAttributes,
int flProtect,
int dwMaximumSizeHigh,
int dwMaximumSizeLow,
String lpName)
Creates or opens a named or unnamed file mapping object for a specified file. |
WinNT.HANDLE |
CreateIoCompletionPort(WinNT.HANDLE FileHandle,
WinNT.HANDLE ExistingCompletionPort,
Pointer CompletionKey,
int NumberOfConcurrentThreads)
Creates an input/output (I/O) completion port and associates it with a specified file handle, or creates an I/O completion port that is not yet associated with a file handle, allowing association at a later time. |
boolean |
CreatePipe(WinNT.HANDLEByReference hReadPipe,
WinNT.HANDLEByReference hWritePipe,
WinBase.SECURITY_ATTRIBUTES lpPipeAttributes,
int nSize)
Creates an anonymous pipe, and returns handles to the read and write ends of the pipe. |
boolean |
CreateProcess(String lpApplicationName,
String lpCommandLine,
WinBase.SECURITY_ATTRIBUTES lpProcessAttributes,
WinBase.SECURITY_ATTRIBUTES lpThreadAttributes,
boolean bInheritHandles,
WinDef.DWORD dwCreationFlags,
Pointer lpEnvironment,
String lpCurrentDirectory,
WinBase.STARTUPINFO lpStartupInfo,
WinBase.PROCESS_INFORMATION lpProcessInformation)
Creates a new process and its primary thread. |
boolean |
CreateProcessW(String lpApplicationName,
char[] lpCommandLine,
WinBase.SECURITY_ATTRIBUTES lpProcessAttributes,
WinBase.SECURITY_ATTRIBUTES lpThreadAttributes,
boolean bInheritHandles,
WinDef.DWORD dwCreationFlags,
Pointer lpEnvironment,
String lpCurrentDirectory,
WinBase.STARTUPINFO lpStartupInfo,
WinBase.PROCESS_INFORMATION lpProcessInformation)
Creates a new process and its primary thread. |
WinNT.HANDLE |
CreateToolhelp32Snapshot(WinDef.DWORD dwFlags,
WinDef.DWORD th32ProcessID)
Takes a snapshot of the specified processes, as well as the heaps, modules, and threads used by these processes. |
boolean |
DeleteFile(String filename)
Deletes an existing file. |
boolean |
DeviceIoControl(WinNT.HANDLE hDevice,
int dwIoControlCode,
Pointer lpInBuffer,
int nInBufferSize,
Pointer lpOutBuffer,
int nOutBufferSize,
IntByReference lpBytesReturned,
Pointer lpOverlapped)
Sends a control code directly to a specified device driver, causing the corresponding device to perform the corresponding operation. |
boolean |
DuplicateHandle(WinNT.HANDLE hSourceProcessHandle,
WinNT.HANDLE hSourceHandle,
WinNT.HANDLE hTargetProcessHandle,
WinNT.HANDLEByReference lpTargetHandle,
int dwDesiredAccess,
boolean bInheritHandle,
int dwOptions)
The DuplicateHandle function duplicates an object handle. |
int |
FormatMessage(int dwFlags,
Pointer lpSource,
int dwMessageId,
int dwLanguageId,
Buffer lpBuffer,
int nSize,
Pointer va_list)
The FormatMessage function formats a message string. |
int |
FormatMessage(int dwFlags,
Pointer lpSource,
int dwMessageId,
int dwLanguageId,
PointerByReference lpBuffer,
int nSize,
Pointer va_list)
The FormatMessage function formats a message string. |
int |
FormatMessage(int dwFlags,
Pointer lpSource,
int dwMessageId,
int dwLanguageId,
Pointer lpBuffer,
int nSize,
Pointer va_list)
The FormatMessage function formats a message string. |
boolean |
GetComputerName(char[] buffer,
IntByReference lpnSize)
Retrieves only the NetBIOS name of the local computer. |
WinNT.HANDLE |
GetCurrentProcess()
This function returns a pseudohandle for the current process. |
int |
GetCurrentProcessId()
This function returns the process identifier of the calling process. |
WinNT.HANDLE |
GetCurrentThread()
The GetCurrentThread function retrieves a pseudo handle for the current thread. |
int |
GetCurrentThreadId()
The GetCurrentThreadId function retrieves the thread identifier of the calling thread. |
boolean |
GetDiskFreeSpaceEx(String lpDirectoryName,
LongByReference lpFreeBytesAvailable,
LongByReference lpTotalNumberOfBytes,
LongByReference lpTotalNumberOfFreeBytes)
Retrieves information about the amount of space that is available on a disk volume, which is the total amount of space, the total amount of free space, and the total amount of free space available to the user that is associated with the calling thread. |
boolean |
GetDiskFreeSpaceEx(String lpDirectoryName,
WinNT.LARGE_INTEGER lpFreeBytesAvailable,
WinNT.LARGE_INTEGER lpTotalNumberOfBytes,
WinNT.LARGE_INTEGER lpTotalNumberOfFreeBytes)
The GetDiskFreeSpaceEx function retrieves information about the amount of space that is available on a disk volume, which is the total amount of space, the total amount of free space, and the total amount of free space available to the user that is associated with the calling thread. |
int |
GetDriveType(String lpRootPathName)
The GetDriveType function determines whether a disk drive is a removable, fixed, CD-ROM, RAM disk, or network drive. |
int |
GetEnvironmentVariable(String lpName,
char[] lpBuffer,
int nSize)
Retrieves the contents of the specified variable from the environment block of the calling process. |
boolean |
GetExitCodeProcess(WinNT.HANDLE hProcess,
IntByReference lpExitCode)
Retrieves the termination status of the specified process. |
int |
GetFileAttributes(String lpFileName)
Retrieves file system attributes for a specified file or directory. |
boolean |
GetFileTime(WinNT.HANDLE hFile,
WinBase.FILETIME lpCreationTime,
WinBase.FILETIME lpLastAccessTime,
WinBase.FILETIME lpLastWriteTime)
Retrieves the date and time that a file or directory was created, last accessed, and last modified. |
int |
GetFileType(WinNT.HANDLE hFile)
Retrieves the file type of the specified file. |
int |
GetLastError()
The GetLastError function retrieves the calling thread's last-error code value. |
void |
GetLocalTime(WinBase.SYSTEMTIME lpSystemTime)
Retrieves the current local date and time. |
WinDef.DWORD |
GetLogicalDriveStrings(WinDef.DWORD nBufferLength,
char[] lpBuffer)
The GetLogicalDriveStrings function fills a buffer with strings that specify valid drives in the system. |
boolean |
GetLogicalProcessorInformation(Pointer buffer,
WinDef.DWORDByReference returnLength)
Retrieves information about logical processors and related hardware. |
WinDef.HMODULE |
GetModuleHandle(String name)
The GetModuleHandle function retrieves a module handle for the specified module if the file has been mapped into the address space of the calling process. |
void |
GetNativeSystemInfo(WinBase.SYSTEM_INFO lpSystemInfo)
The GetNativeSystemInfo function retrieves information about the current system to an application running under WOW64. |
int |
GetPrivateProfileInt(String appName,
String keyName,
int defaultValue,
String fileName)
Retrieves an integer associated with a key in the specified section of an initialization file. |
WinDef.DWORD |
GetPrivateProfileString(String lpAppName,
String lpKeyName,
String lpDefault,
char[] lpReturnedString,
WinDef.DWORD nSize,
String lpFileName)
Retrieves a string from the specified section in an initialization file. |
int |
GetProcessId(WinNT.HANDLE process)
The GetProcessId function retrieves the process identifier of the specified process. |
int |
GetProcessVersion(int processId)
The GetProcessVersion function retrieves the major and minor version numbers of the system on which the specified process expects to run. |
boolean |
GetQueuedCompletionStatus(WinNT.HANDLE CompletionPort,
IntByReference lpNumberOfBytes,
BaseTSD.ULONG_PTRByReference lpCompletionKey,
PointerByReference lpOverlapped,
int dwMilliseconds)
Attempts to dequeue an I/O completion packet from the specified I/O completion port. |
int |
GetShortPathName(String lpszLongPath,
char[] lpdzShortPath,
int cchBuffer)
Retrieves the short path form of the specified path. |
WinDef.LCID |
GetSystemDefaultLCID()
Returns the locale identifier for the system locale. |
void |
GetSystemInfo(WinBase.SYSTEM_INFO lpSystemInfo)
The GetSystemInfo function returns information about the current system. |
void |
GetSystemTime(WinBase.SYSTEMTIME lpSystemTime)
The GetSystemTime function retrieves the current system date and time. |
WinDef.DWORD |
GetTempPath(WinDef.DWORD nBufferLength,
char[] buffer)
The GetTempPath function retrieves the path of the directory designated for temporary files. |
int |
GetTickCount()
The GetTickCount function retrieves the number of milliseconds that have elapsed since the system was started, up to 49.7 days. |
WinDef.LCID |
GetUserDefaultLCID()
Returns the locale identifier for the user default locale. |
WinDef.DWORD |
GetVersion()
The GetVersion function returns the current version number of the operating system. |
boolean |
GetVersionEx(WinNT.OSVERSIONINFO lpVersionInfo)
The GetVersionEx function obtains extended information about the version of the operating system that is currently running. |
boolean |
GetVersionEx(WinNT.OSVERSIONINFOEX lpVersionInfo)
The GetVersionEx function obtains extended information about the version of the operating system that is currently running. |
Pointer |
GlobalFree(Pointer hGlobal)
Frees the specified global memory object and invalidates its handle. |
boolean |
GlobalMemoryStatusEx(WinBase.MEMORYSTATUSEX lpBuffer)
Retrieves information about the system's current usage of both physical and virtual memory. |
boolean |
IsWow64Process(WinNT.HANDLE hProcess,
IntByReference Wow64Process)
The IsWow64Process function determines whether the specified process is running under WOW64. |
Pointer |
LocalAlloc(int uFlags,
int uBytes)
The LocalAlloc function allocates the specified number of bytes from the heap. |
Pointer |
LocalFree(Pointer hLocal)
Frees the specified local memory object and invalidates its handle. |
Pointer |
MapViewOfFile(WinNT.HANDLE hFileMappingObject,
int dwDesiredAccess,
int dwFileOffsetHigh,
int dwFileOffsetLow,
int dwNumberOfBytesToMap)
Maps a view of a file mapping into the address space of a calling process. |
boolean |
MoveFile(String lpExistingFileName,
String lpNewFileName)
Moves an existing file or a directory, including its children. |
boolean |
MoveFileEx(String lpExistingFileName,
String lpNewFileName,
WinDef.DWORD dwFlags)
Moves an existing file or directory, including its children, with various move options. |
WinNT.HANDLE |
OpenProcess(int fdwAccess,
boolean fInherit,
int IDProcess)
This function returns a handle to an existing process object. |
WinNT.HANDLE |
OpenThread(int dwDesiredAccess,
boolean bInheritHandle,
int dwThreadId)
The OpenThread function opens an existing thread object. |
boolean |
PostQueuedCompletionStatus(WinNT.HANDLE CompletionPort,
int dwNumberOfBytesTransferred,
Pointer dwCompletionKey,
WinBase.OVERLAPPED lpOverlapped)
Posts an I/O completion packet to an I/O completion port. |
boolean |
Process32First(WinNT.HANDLE hSnapshot,
Tlhelp32.PROCESSENTRY32 lppe)
Retrieves information about the first process encountered in a system snapshot. |
boolean |
Process32Next(WinNT.HANDLE hSnapshot,
Tlhelp32.PROCESSENTRY32 lppe)
Retrieves information about the next process recorded in a system snapshot. |
boolean |
PulseEvent(WinNT.HANDLE hEvent)
Sets the specified event object to the signaled state and then resets it to the nonsignaled state after releasing the appropriate number of waiting threads. |
boolean |
ReadDirectoryChangesW(WinNT.HANDLE directory,
WinNT.FILE_NOTIFY_INFORMATION info,
int length,
boolean watchSubtree,
int notifyFilter,
IntByReference bytesReturned,
WinBase.OVERLAPPED overlapped,
WinNT.OVERLAPPED_COMPLETION_ROUTINE completionRoutine)
Retrieves information that describes the changes within the specified directory. |
boolean |
ReadFile(WinNT.HANDLE hFile,
Buffer lpBuffer,
int nNumberOfBytesToRead,
IntByReference lpNumberOfBytesRead,
WinBase.OVERLAPPED lpOverlapped)
Reads data from the specified file or input/output (I/O) device. |
boolean |
ReadFile(WinNT.HANDLE hFile,
Pointer lpBuffer,
int nNumberOfBytesToRead,
IntByReference lpNumberOfBytesRead,
WinBase.OVERLAPPED lpOverlapped)
Reads data from the specified file or input/output (I/O) device. |
boolean |
SetEnvironmentVariable(String lpName,
String lpValue)
The SetEnvironmentVariable function sets the contents of the specified environment variable for the current process. |
boolean |
SetEvent(WinNT.HANDLE hEvent)
Sets the specified event object to the signaled state. |
boolean |
SetFileAttributes(String lpFileName,
WinDef.DWORD dwFileAttributes)
Sets the attributes for a file or directory. |
int |
SetFileTime(WinNT.HANDLE hFile,
WinBase.FILETIME lpCreationTime,
WinBase.FILETIME lpLastAccessTime,
WinBase.FILETIME lpLastWriteTime)
Sets the date and time that the specified file or directory was created, last accessed, or last modified. |
boolean |
SetHandleInformation(WinNT.HANDLE hObject,
int dwMask,
int dwFlags)
Sets certain properties of an object handle. |
void |
SetLastError(int dwErrCode)
The SetLastError function sets the last-error code for the calling thread. |
boolean |
TerminateProcess(WinNT.HANDLE hProcess,
int uExitCode)
Terminates the specified process and all of its threads. |
boolean |
UnmapViewOfFile(Pointer lpBaseAddress)
Unmaps a mapped view of a file from the calling process's address space. |
int |
WaitForMultipleObjects(int nCount,
WinNT.HANDLE[] hHandle,
boolean bWaitAll,
int dwMilliseconds)
Waits until one or all of the specified objects are in the signaled state or the time-out interval elapses. |
int |
WaitForSingleObject(WinNT.HANDLE hHandle,
int dwMilliseconds)
Waits until the specified object is in the signaled state or the time-out interval elapses. |
boolean |
WriteFile(WinNT.HANDLE hFile,
byte[] lpBuffer,
int nNumberOfBytesToWrite,
IntByReference lpNumberOfBytesWritten,
WinBase.OVERLAPPED lpOverlapped)
Writes data to the specified file or input/output (I/O) device. |
boolean |
WritePrivateProfileString(String lpAppName,
String lpKeyName,
String lpString,
String lpFileName)
Copies a string into the specified section of an initialization file. |
Field Detail |
---|
static final Kernel32 INSTANCE
Method Detail |
---|
int FormatMessage(int dwFlags, Pointer lpSource, int dwMessageId, int dwLanguageId, Buffer lpBuffer, int nSize, Pointer va_list)
dwFlags
- Formatting options, and how to interpret the lpSource
parameter. The low-order byte of dwFlags specifies how the
function handles line breaks in the output buffer. The
low-order byte can also specify the maximum width of a
formatted output line.
This version of the function assumes
FORMAT_MESSAGE_ALLOCATE_BUFFER is not set.lpSource
- Location of the message definition.dwMessageId
- Message identifier for the requested message.dwLanguageId
- Language identifier for the requested message.lpBuffer
- Pointer to a buffer that receives the null-terminated string
that specifies the formatted message.nSize
- This this parameter specifies the size of the output buffer,
in TCHARs. If FORMAT_MESSAGE_ALLOCATE_BUFFER isva_list
- Pointer to an array of values that are used as insert values
in the formatted message.
boolean ReadFile(WinNT.HANDLE hFile, Buffer lpBuffer, int nNumberOfBytesToRead, IntByReference lpNumberOfBytesRead, WinBase.OVERLAPPED lpOverlapped)
hFile
- A handle to the device (for example, a file, file stream,
physical disk, volume, console buffer, tape drive, socket,
communications resource, mailslot, or pipe).lpBuffer
- A pointer to the buffer that receives the data read from a
file or device.nNumberOfBytesToRead
- The maximum number of bytes to be read.lpNumberOfBytesRead
- A pointer to the variable that receives the number of bytes
read when using a synchronous hFile parameterlpOverlapped
- A pointer to an OVERLAPPED structure is required if the hFile
parameter was opened with FILE_FLAG_OVERLAPPED, otherwise it
can be NULL.
Pointer LocalFree(Pointer hLocal)
hLocal
- A handle to the local memory object.
Pointer GlobalFree(Pointer hGlobal)
hGlobal
- A handle to the global memory object.
WinDef.HMODULE GetModuleHandle(String name)
name
- Pointer to a null-terminated string that contains the name of
the module (either a .dll or .exe file).
void GetSystemTime(WinBase.SYSTEMTIME lpSystemTime)
lpSystemTime
- Pointer to a SYSTEMTIME structure to receive the current
system date and time.void GetLocalTime(WinBase.SYSTEMTIME lpSystemTime)
lpSystemTime
- A pointer to a SYSTEMTIME structure to receive the current
local date and time.int GetTickCount()
int GetCurrentThreadId()
WinNT.HANDLE GetCurrentThread()
int GetCurrentProcessId()
WinNT.HANDLE GetCurrentProcess()
int GetProcessId(WinNT.HANDLE process)
process
- Handle to the process. The handle must have the
PROCESS_QUERY_INFORMATION access right.
int GetProcessVersion(int processId)
processId
- Process identifier of the process of interest. A value of zero
specifies the calling process.
boolean GetExitCodeProcess(WinNT.HANDLE hProcess, IntByReference lpExitCode)
hProcess
- A handle to the process.lpExitCode
- A pointer to a variable to receive the process termination
status.
boolean TerminateProcess(WinNT.HANDLE hProcess, int uExitCode)
hProcess
- A handle to the process to be terminated.uExitCode
- The exit code to be used by the process and threads terminated
as a result of this call.
int GetLastError()
void SetLastError(int dwErrCode)
dwErrCode
- Last-error code for the thread.int GetDriveType(String lpRootPathName)
lpRootPathName
- Pointer to a null-terminated string that specifies the root
directory of the disk to return information about. A trailing
backslash is required. If this parameter is NULL, the function
uses the root of the current directory.
int FormatMessage(int dwFlags, Pointer lpSource, int dwMessageId, int dwLanguageId, Pointer lpBuffer, int nSize, Pointer va_list)
dwFlags
- Formatting options, and how to interpret the lpSource
parameter. The low-order byte of dwFlags specifies how the
function handles line breaks in the output buffer. The
low-order byte can also specify the maximum width of a
formatted output line.
This version of the function assumes
FORMAT_MESSAGE_ALLOCATE_BUFFER is not set.lpSource
- Location of the message definition.dwMessageId
- Message identifier for the requested message.dwLanguageId
- Language identifier for the requested message.lpBuffer
- Pointer to a buffer that receives the null-terminated string
that specifies the formatted message.nSize
- This this parameter specifies the size of the output buffer,
in TCHARs. If FORMAT_MESSAGE_ALLOCATE_BUFFER isva_list
- Pointer to an array of values that are used as insert values
in the formatted message.
int FormatMessage(int dwFlags, Pointer lpSource, int dwMessageId, int dwLanguageId, PointerByReference lpBuffer, int nSize, Pointer va_list)
dwFlags
- Formatting options, and how to interpret the lpSource
parameter. The low-order byte of dwFlags specifies how the
function handles line breaks in the output buffer. The
low-order byte can also specify the maximum width of a
formatted output line.
This version of the function assumes
FORMAT_MESSAGE_ALLOCATE_BUFFER is set.lpSource
- Location of the message definition.dwMessageId
- Message identifier for the requested message.dwLanguageId
- Language identifier for the requested message.lpBuffer
- Pointer to a pointer that receives the allocated buffer in
which the null-terminated string that specifies the formatted
message is written.nSize
- This parameter specifies the minimum number of TCHARs to
allocate for an output buffer.va_list
- Pointer to an array of values that are used as insert values
in the formatted message.
WinNT.HANDLE CreateFile(String lpFileName, int dwDesiredAccess, int dwShareMode, WinBase.SECURITY_ATTRIBUTES lpSecurityAttributes, int dwCreationDisposition, int dwFlagsAndAttributes, WinNT.HANDLE hTemplateFile)
lpFileName
- A pointer to a null-terminated string that specifies the name
of an object to create or open.dwDesiredAccess
- The access to the object, which can be read, write, or both.dwShareMode
- The sharing mode of an object, which can be read, write, both,
or none.lpSecurityAttributes
- A pointer to a SECURITY_ATTRIBUTES structure that determines
whether or not the returned handle can be inherited by child
processes. If lpSecurityAttributes is NULL, the handle cannot
be inherited.dwCreationDisposition
- An action to take on files that exist and do not exist.dwFlagsAndAttributes
- The file attributes and flags.hTemplateFile
- Handle to a template file with the GENERIC_READ access right.
The template file supplies file attributes and extended
attributes for the file that is being created. This parameter
can be NULL.
boolean CopyFile(String lpExistingFileName, String lpNewFileName, boolean bFailIfExists)
lpExistingFileName
- The name of an existing file.
The name is limited to MAX_PATH characters. To extend this
limit to 32,767 wide characters, prepend "\\?\" to the path.
For more information, see Naming a File.
If lpExistingFileName does not exist, CopyFile fails, and
GetLastError returns ERROR_FILE_NOT_FOUND.lpNewFileName
- The name of the new file.
The name is limited to MAX_PATH characters. To extend this
limit to 32,767 wide characters, prepend "\\?\" to the path.
For more information, see Naming a File.bFailIfExists
- If this parameter is TRUE and the new file specified by
lpNewFileName already exists, the function fails. If this
parameter is FALSE and the new file already exists, the
function overwrites the existing file and succeeds.
boolean MoveFile(String lpExistingFileName, String lpNewFileName)
lpExistingFileName
- The current name of the file or directory on the local
computer.
The name is limited to MAX_PATH characters. To extend this
limit to 32,767 wide characters, prepend "\\?\" to the path.
For more information, see Naming a File.lpNewFileName
- The new name for the file or directory. The new name must not
already exist. A new file may be on a different file system or
drive. A new directory must be on the same drive.
The name is limited to MAX_PATH characters. To extend this
limit to 32,767 wide characters, prepend "\\?\" to the path.
For more information, see Naming a File.
boolean MoveFileEx(String lpExistingFileName, String lpNewFileName, WinDef.DWORD dwFlags)
lpExistingFileName
- The current name of the file or directory on the local
computer.
If dwFlags specifies MOVEFILE_DELAY_UNTIL_REBOOT, the file
cannot exist on a remote share, because delayed operations are
performed before the network is available.
The name is limited to MAX_PATH characters. To extend this
limit to 32,767 wide characters, prepend "\\?\" to the path.
For more information, see Naming a File
Windows 2000: If you prepend the file name with "\\?\", you
cannot also specify the MOVEFILE_DELAY_UNTIL_REBOOT flag for
dwFlags.lpNewFileName
- The new name of the file or directory on the local computer.
When moving a file, the destination can be on a different file
system or volume. If the destination is on another drive, you
must set the MOVEFILE_COPY_ALLOWED flag in dwFlags.
When moving a directory, the destination must be on the same
drive.
If dwFlags specifies MOVEFILE_DELAY_UNTIL_REBOOT and
lpNewFileName is NULL, MoveFileEx registers the
lpExistingFileName file to be deleted when the system
restarts. If lpExistingFileName refers to a directory, the
system removes the directory at restart only if the directory
is empty.dwFlags
- This parameter can be one or more of the following values.
boolean CreateDirectory(String lpPathName, WinBase.SECURITY_ATTRIBUTES lpSecurityAttributes)
lpPathName
- Pointer to a null-terminated string that specifies the path of
the directory to be created.lpSecurityAttributes
- Pointer to a SECURITY_ATTRIBUTES structure. The
lpSecurityDescriptor member of the structure specifies a
security descriptor for the new directory. If
lpSecurityAttributes is NULL, the directory gets a default
security descriptor.
boolean ReadFile(WinNT.HANDLE hFile, Pointer lpBuffer, int nNumberOfBytesToRead, IntByReference lpNumberOfBytesRead, WinBase.OVERLAPPED lpOverlapped)
hFile
- A handle to the device (for example, a file, file stream,
physical disk, volume, console buffer, tape drive, socket,
communications resource, mailslot, or pipe).lpBuffer
- A pointer to the buffer that receives the data read from a
file or device.nNumberOfBytesToRead
- The maximum number of bytes to be read.lpNumberOfBytesRead
- A pointer to the variable that receives the number of bytes
read when using a synchronous hFile parameterlpOverlapped
- A pointer to an OVERLAPPED structure is required if the hFile
parameter was opened with FILE_FLAG_OVERLAPPED, otherwise it
can be NULL.
WinNT.HANDLE CreateIoCompletionPort(WinNT.HANDLE FileHandle, WinNT.HANDLE ExistingCompletionPort, Pointer CompletionKey, int NumberOfConcurrentThreads)
FileHandle
- An open file handle or INVALID_HANDLE_VALUE.ExistingCompletionPort
- A handle to an existing I/O completion port or NULL.CompletionKey
- The per-handle user-defined completion key that is included in
every I/O completion packet for the specified file handle.NumberOfConcurrentThreads
- The maximum number of threads that the operating system can
allow to concurrently process I/O completion packets for the
I/O completion port.
boolean GetQueuedCompletionStatus(WinNT.HANDLE CompletionPort, IntByReference lpNumberOfBytes, BaseTSD.ULONG_PTRByReference lpCompletionKey, PointerByReference lpOverlapped, int dwMilliseconds)
CompletionPort
- A handle to the completion port.lpNumberOfBytes
- A pointer to a variable that receives the number of bytes
transferred during an I/O operation that has completed.lpCompletionKey
- A pointer to a variable that receives the completion key value
associated with the file handle whose I/O operation has
completed.lpOverlapped
- A pointer to a variable that receives the address of the
OVERLAPPED structure that was specified when the completed I/O
operation was started.dwMilliseconds
- The number of milliseconds that the caller is willing to wait
for a completion packet to appear at the completion port.
boolean PostQueuedCompletionStatus(WinNT.HANDLE CompletionPort, int dwNumberOfBytesTransferred, Pointer dwCompletionKey, WinBase.OVERLAPPED lpOverlapped)
CompletionPort
- A handle to an I/O completion port to which the I/O completion
packet is to be posted.dwNumberOfBytesTransferred
- The value to be returned through the
lpNumberOfBytesTransferred parameter of the
GetQueuedCompletionStatus function.dwCompletionKey
- The value to be returned through the lpCompletionKey parameter
of the GetQueuedCompletionStatus function.lpOverlapped
- The value to be returned through the lpOverlapped parameter of
the GetQueuedCompletionStatus function.
int WaitForSingleObject(WinNT.HANDLE hHandle, int dwMilliseconds)
hHandle
- A handle to the object. For a list of the object types whose
handles can be specified, see the following Remarks section.
If this handle is closed while the wait is still pending, the
function's behavior is undefined. The handle must have the
SYNCHRONIZE access right. For more information, see Standard
Access Rights.dwMilliseconds
- The time-out interval, in milliseconds. If a nonzero value is
specified, the function waits until the object is signaled or
the interval elapses. If dwMilliseconds is zero, the function
does not enter a wait state if the object is not signaled; it
always returns immediately. If dwMilliseconds is INFINITE, the
function will return only when the object is signaled.
int WaitForMultipleObjects(int nCount, WinNT.HANDLE[] hHandle, boolean bWaitAll, int dwMilliseconds)
nCount
- The number of object handles in the array pointed to by
lpHandles. The maximum number of object handles is
MAXIMUM_WAIT_OBJECTS.hHandle
- An array of object handles. For a list of the object types
whose handles can be specified, see the following Remarks
section. The array can contain handles to objects of different
types. It may not contain multiple copies of the same handle.
If one of these handles is closed while the wait is still
pending, the function's behavior is undefined. The handles
must have the SYNCHRONIZE access right. For more information,
see Standard Access Rights.bWaitAll
- If this parameter is TRUE, the function returns when the state
of all objects in the lpHandles array is signaled. If FALSE,
the function returns when the state of any one of the objects
is set to signaled. In the latter case, the return value
indicates the object whose state caused the function to
return.dwMilliseconds
- The time-out interval, in milliseconds. If a nonzero value is
specified, the function waits until the specified objects are
signaled or the interval elapses. If dwMilliseconds is zero,
the function does not enter a wait state if the specified
objects are not signaled; it always returns immediately. If
dwMilliseconds is INFINITE, the function will return only when
the specified objects are signaled.
boolean DuplicateHandle(WinNT.HANDLE hSourceProcessHandle, WinNT.HANDLE hSourceHandle, WinNT.HANDLE hTargetProcessHandle, WinNT.HANDLEByReference lpTargetHandle, int dwDesiredAccess, boolean bInheritHandle, int dwOptions)
hSourceProcessHandle
- Handle to the process with the handle to duplicate. The handle
must have the PROCESS_DUP_HANDLE access right.hSourceHandle
- Handle to duplicate. This is an open object handle that is
valid in the context of the source process.hTargetProcessHandle
- Handle to the process that is to receive the duplicated
handle. The handle must have the PROCESS_DUP_HANDLE access
right.lpTargetHandle
- Pointer to a variable that receives the duplicate handle. This
handle value is valid in the context of the target process. If
hSourceHandle is a pseudo handle returned by GetCurrentProcess
or GetCurrentThread, DuplicateHandle converts it to a real
handle to a process or thread, respectively.dwDesiredAccess
- Access requested for the new handle.bInheritHandle
- Indicates whether the handle is inheritable.dwOptions
- Optional actions.
boolean CloseHandle(WinNT.HANDLE hObject)
hObject
- Handle to an open object. This parameter can be a pseudo
handle or INVALID_HANDLE_VALUE.
boolean ReadDirectoryChangesW(WinNT.HANDLE directory, WinNT.FILE_NOTIFY_INFORMATION info, int length, boolean watchSubtree, int notifyFilter, IntByReference bytesReturned, WinBase.OVERLAPPED overlapped, WinNT.OVERLAPPED_COMPLETION_ROUTINE completionRoutine)
directory
- A handle to the directory to be monitored. This directory must
be opened with the FILE_LIST_DIRECTORY access right.info
- A pointer to the DWORD-aligned formatted buffer in which the
read results are to be returned.length
- The size of the buffer that is pointed to by the lpBuffer
parameter, in bytes.watchSubtree
- If this parameter is TRUE, the function monitors the directory
tree rooted at the specified directory. If this parameter is
FALSE, the function monitors only the directory specified by
the hDirectory parameter.notifyFilter
- The filter criteria that the function checks to determine if
the wait operation has completed.bytesReturned
- For synchronous calls, this parameter receives the number of
bytes transferred into the lpBuffer parameter. For
asynchronous calls, this parameter is undefined. You must use
an asynchronous notification technique to retrieve the number
of bytes transferred.overlapped
- A pointer to an OVERLAPPED structure that supplies data to be
used during asynchronous operation. Otherwise, this value is
NULL. The Offset and OffsetHigh members of this structure are
not used.completionRoutine
- A pointer to a completion routine to be called when the
operation has been completed or canceled and the calling
thread is in an alertable wait state.
int GetShortPathName(String lpszLongPath, char[] lpdzShortPath, int cchBuffer)
lpszLongPath
- The path string.lpdzShortPath
- A pointer to a buffer to receive the null-terminated short
form of the path that lpszLongPath specifies.cchBuffer
- The size of the buffer that lpszShortPath points to, in
TCHARs.
Pointer LocalAlloc(int uFlags, int uBytes)
uFlags
- Memory allocation attributes. The default is the LMEM_FIXED
value.uBytes
- Number of bytes to allocate. If this parameter is zero and the
uFlags parameter specifies LMEM_MOVEABLE, the function returns
a handle to a memory object that is marked as discarded.
boolean WriteFile(WinNT.HANDLE hFile, byte[] lpBuffer, int nNumberOfBytesToWrite, IntByReference lpNumberOfBytesWritten, WinBase.OVERLAPPED lpOverlapped)
hFile
- A handle to the file or I/O device (for example, a file, file
stream, physical disk, volume, console buffer, tape drive,
socket, communications resource, mailslot, or pipe).lpBuffer
- A pointer to the buffer containing the data to be written to
the file or device.nNumberOfBytesToWrite
- The number of bytes to be written to the file or device.lpNumberOfBytesWritten
- A pointer to the variable that receives the number of bytes
written when using a synchronous hFile parameter.lpOverlapped
- A pointer to an OVERLAPPED structure is required if the hFile
parameter was opened with FILE_FLAG_OVERLAPPED, otherwise this
parameter can be NULL.
WinNT.HANDLE CreateEvent(WinBase.SECURITY_ATTRIBUTES lpEventAttributes, boolean bManualReset, boolean bInitialState, String lpName)
lpEventAttributes
- A pointer to a SECURITY_ATTRIBUTES structure. If this
parameter is NULL, the handle cannot be inherited by child
processes.bManualReset
- If this parameter is TRUE, the function creates a manual-reset
event object, which requires the use of the ResetEvent
function to set the event state to nonsignaled. If this
parameter is FALSE, the function creates an auto-reset event
object, and system automatically resets the event state to
nonsignaled after a single waiting thread has been released.bInitialState
- If this parameter is TRUE, the initial state of the event
object is signaled; otherwise, it is nonsignaled.lpName
- The name of the event object. The name is limited to MAX_PATH
characters. Name comparison is case sensitive.
boolean SetEvent(WinNT.HANDLE hEvent)
hEvent
- A handle to the event object. The CreateEvent or OpenEvent
function returns this handle.
boolean PulseEvent(WinNT.HANDLE hEvent)
hEvent
- A handle to the event object. The CreateEvent or OpenEvent
function returns this handle.
WinNT.HANDLE CreateFileMapping(WinNT.HANDLE hFile, WinBase.SECURITY_ATTRIBUTES lpAttributes, int flProtect, int dwMaximumSizeHigh, int dwMaximumSizeLow, String lpName)
hFile
- A handle to the file from which to create a file mapping
object.lpAttributes
- A pointer to a SECURITY_ATTRIBUTES structure that determines
whether a returned handle can be inherited by child processes.
The lpSecurityDescriptor member of the SECURITY_ATTRIBUTES
structure specifies a security descriptor for a new file
mapping object.flProtect
- Specifies the page protection of the file mapping object. All
mapped views of the object must be compatible with this
protection.dwMaximumSizeHigh
- The high-order DWORD of the maximum size of the file mapping
object.dwMaximumSizeLow
- The low-order DWORD of the maximum size of the file mapping
object.lpName
- The name of the file mapping object.
Pointer MapViewOfFile(WinNT.HANDLE hFileMappingObject, int dwDesiredAccess, int dwFileOffsetHigh, int dwFileOffsetLow, int dwNumberOfBytesToMap)
hFileMappingObject
- A handle to a file mapping object. The CreateFileMapping and
OpenFileMapping functions return this handle.dwDesiredAccess
- The type of access to a file mapping object, which determines
the protection of the pages.dwFileOffsetHigh
- A high-order DWORD of the file offset where the view begins.dwFileOffsetLow
- A low-order DWORD of the file offset where the view is to
begin.dwNumberOfBytesToMap
- The number of bytes of a file mapping to map to the view.
boolean UnmapViewOfFile(Pointer lpBaseAddress)
lpBaseAddress
- A pointer to the base address of the mapped view of a file
that is to be unmapped.
boolean GetComputerName(char[] buffer, IntByReference lpnSize)
buffer
- A pointer to a buffer that receives the computer name or the
cluster virtual server name. The buffer size should be large
enough to contain MAX_COMPUTERNAME_LENGTH + 1 characters.lpnSize
- On input, specifies the size of the buffer, in TCHARs. On
output, the number of TCHARs copied to the destination buffer,
not including the terminating null character. If the buffer is
too small, the function fails and GetLastError returns
ERROR_BUFFER_OVERFLOW. The lpnSize parameter specifies the
size of the buffer required, including the terminating null
character.
WinNT.HANDLE OpenThread(int dwDesiredAccess, boolean bInheritHandle, int dwThreadId)
dwDesiredAccess
- Access to the thread object. This access right is checked
against any security descriptor for the thread.bInheritHandle
- If this parameter is TRUE, the new process inherits the
handle. If the parameter is FALSE, the handle is not
inherited.dwThreadId
- Identifier of the thread to be opened.
boolean CreateProcess(String lpApplicationName, String lpCommandLine, WinBase.SECURITY_ATTRIBUTES lpProcessAttributes, WinBase.SECURITY_ATTRIBUTES lpThreadAttributes, boolean bInheritHandles, WinDef.DWORD dwCreationFlags, Pointer lpEnvironment, String lpCurrentDirectory, WinBase.STARTUPINFO lpStartupInfo, WinBase.PROCESS_INFORMATION lpProcessInformation)
lpApplicationName
- The name of the module to be executed.lpCommandLine
- The command line to be executed.lpProcessAttributes
- A pointer to a SECURITY_ATTRIBUTES structure that determines
whether the returned handle to the new process object can be
inherited by child processes. If lpProcessAttributes is NULL,
the handle cannot be inherited.lpThreadAttributes
- A pointer to a SECURITY_ATTRIBUTES structure that determines
whether the returned handle to the new thread object can be
inherited by child processes. If lpThreadAttributes is NULL,
the handle cannot be inherited.bInheritHandles
- If this parameter TRUE, each inheritable handle in the calling
process is inherited by the new process. If the parameter is
FALSE, the handles are not inherited. Note that inherited
handles have the same value and access rights as the original
handles.dwCreationFlags
- The flags that control the priority class and the creation of
the process.lpEnvironment
- A pointer to the environment block for the new process. If
this parameter is NULL, the new process uses the environment
of the calling process.lpCurrentDirectory
- The full path to the current directory for the process.lpStartupInfo
- A pointer to a STARTUPINFO or STARTUPINFOEX structure.lpProcessInformation
- A pointer to a PROCESS_INFORMATION structure that receives
identification information about the new process.
boolean CreateProcessW(String lpApplicationName, char[] lpCommandLine, WinBase.SECURITY_ATTRIBUTES lpProcessAttributes, WinBase.SECURITY_ATTRIBUTES lpThreadAttributes, boolean bInheritHandles, WinDef.DWORD dwCreationFlags, Pointer lpEnvironment, String lpCurrentDirectory, WinBase.STARTUPINFO lpStartupInfo, WinBase.PROCESS_INFORMATION lpProcessInformation)
lpApplicationName
- The name of the module to be executed.lpCommandLine
- The command line to be executed. The maximum length of
this string is 32,768 characters, including the Unicode
terminating null character. If lpApplicationName is
NULL, the module name portion of lpCommandLine is
limited to MAX_PATH characters.
The Unicode version of this function, CreateProcessW(java.lang.String, char[], com.sun.jna.platform.win32.WinBase.SECURITY_ATTRIBUTES, com.sun.jna.platform.win32.WinBase.SECURITY_ATTRIBUTES, boolean, com.sun.jna.platform.win32.WinDef.DWORD, com.sun.jna.Pointer, java.lang.String, com.sun.jna.platform.win32.WinBase.STARTUPINFO, com.sun.jna.platform.win32.WinBase.PROCESS_INFORMATION)
,
can modify the contents of this string. Therefore, this
parameter cannot be a pointer to read-only memory (such
as a const variable or a literal string). If this
parameter is a constant string, the function may cause
an access violation.
The lpCommandLine parameter can be NULL. In that case,
the function uses the string pointed to by
lpApplicationName as the command line.
If both lpApplicationName and lpCommandLine are
non-NULL, the null-terminated string pointed to by
lpApplicationName specifies the module to execute, and
the null-terminated string pointed to by lpCommandLine
specifies the command line. The new process can use
GetCommandLine to retrieve the entire command
line. Console processes written in C can use the argc
and argv arguments to parse the command line. Because
argv[0] is the module name, C programmers generally
repeat the module name as the first token in the command
line.
If lpApplicationName is NULL, the first white
space-delimited token of the command line specifies the
module name. If you are using a long file name that
contains a space, use quoted strings to indicate where
the file name ends and the arguments begin (see the
explanation for the lpApplicationName parameter). If the
file name does not contain an extension, .exe is
appended. Therefore, if the file name extension is .com,
this parameter must include the .com extension. If the
file name ends in a period (.) with no extension, or if
the file name contains a path, .exe is not appended. If
the file name does not contain a directory path, the
system searches for the executable file in the following
sequence:
lpProcessAttributes
- A pointer to a SECURITY_ATTRIBUTES structure that determines
whether the returned handle to the new process object can be
inherited by child processes. If lpProcessAttributes is NULL,
the handle cannot be inherited.lpThreadAttributes
- A pointer to a SECURITY_ATTRIBUTES structure that determines
whether the returned handle to the new thread object can be
inherited by child processes. If lpThreadAttributes is NULL,
the handle cannot be inherited.bInheritHandles
- If this parameter TRUE, each inheritable handle in the calling
process is inherited by the new process. If the parameter is
FALSE, the handles are not inherited. Note that inherited
handles have the same value and access rights as the original
handles.dwCreationFlags
- The flags that control the priority class and the creation of
the process.lpEnvironment
- A pointer to the environment block for the new process. If
this parameter is NULL, the new process uses the environment
of the calling process.lpCurrentDirectory
- The full path to the current directory for the process.lpStartupInfo
- A pointer to a STARTUPINFO or STARTUPINFOEX structure.lpProcessInformation
- A pointer to a PROCESS_INFORMATION structure that receives
identification information about the new process.
WinNT.HANDLE OpenProcess(int fdwAccess, boolean fInherit, int IDProcess)
fdwAccess
- Not supported; set to zero.fInherit
- Not supported; set to FALSE.IDProcess
- Specifies the process identifier of the process to open.
WinDef.DWORD GetTempPath(WinDef.DWORD nBufferLength, char[] buffer)
nBufferLength
- Size of the string buffer identified by lpBuffer, in TCHARs.buffer
- Pointer to a string buffer that receives the null-terminated
string specifying the temporary file path. The returned string
ends with a backslash, for example, C:\TEMP\.
WinDef.DWORD GetVersion()
boolean GetVersionEx(WinNT.OSVERSIONINFO lpVersionInfo)
lpVersionInfo
- Pointer to an OSVERSIONINFO data structure that the function
fills with operating system version information.
boolean GetVersionEx(WinNT.OSVERSIONINFOEX lpVersionInfo)
lpVersionInfo
- Pointer to an OSVERSIONINFOEX data structure that the function
fills with operating system version information.
void GetSystemInfo(WinBase.SYSTEM_INFO lpSystemInfo)
lpSystemInfo
- Pointer to a SYSTEM_INFO structure that receives the
information.void GetNativeSystemInfo(WinBase.SYSTEM_INFO lpSystemInfo)
lpSystemInfo
- Pointer to a SYSTEM_INFO structure that receives the
information.boolean IsWow64Process(WinNT.HANDLE hProcess, IntByReference Wow64Process)
hProcess
- Handle to a process.Wow64Process
- Pointer to a value that is set to TRUE if the process is
running under WOW64. Otherwise, the value is set to FALSE.
boolean GetLogicalProcessorInformation(Pointer buffer, WinDef.DWORDByReference returnLength)
buffer
- a buffer which receives an array of WinNT.SYSTEM_LOGICAL_PROCESSOR_INFORMATION
structures.returnLength
- on input, specifies the length of the buffer in bytes. On output, receives the number of
bytes actually returned, or if GetLastError()
returned
WinError.ERROR_INSUFFICIENT_BUFFER
, the number of bytes wanted for the call to work.
true
on success, false
on failure. To get extended error information, call
GetLastError()
.boolean GlobalMemoryStatusEx(WinBase.MEMORYSTATUSEX lpBuffer)
lpBuffer
- A pointer to a MEMORYSTATUSEX structure that receives
information about current memory availability.
boolean GetFileTime(WinNT.HANDLE hFile, WinBase.FILETIME lpCreationTime, WinBase.FILETIME lpLastAccessTime, WinBase.FILETIME lpLastWriteTime)
hFile
- A handle to the file or directory for which dates and times
are to be retrieved. The handle must have been created using
the CreateFile function with the GENERIC_READ access right.lpCreationTime
- A pointer to a FILETIME structure to receive the date and time
the file or directory was created. This parameter can be NULL
if the application does not require this information.lpLastAccessTime
- A pointer to a FILETIME structure to receive the date and time
the file or directory was last accessed. The last access time
includes the last time the file or directory was written to,
read from, or, in the case of executable files, run. This
parameter can be NULL if the application does not require this
information.lpLastWriteTime
- A pointer to a FILETIME structure to receive the date and time
the file or directory was last written to, truncated, or
overwritten (for example, with WriteFile or SetEndOfFile).
This date and time is not updated when file attributes or
security descriptors are changed. This parameter can be NULL
if the application does not require this information.
int SetFileTime(WinNT.HANDLE hFile, WinBase.FILETIME lpCreationTime, WinBase.FILETIME lpLastAccessTime, WinBase.FILETIME lpLastWriteTime)
hFile
- A handle to the file or directory. The handle must have been
created using the CreateFile function with the
FILE_WRITE_ATTRIBUTES access right. For more information, see
File Security and Access Rights.lpCreationTime
- A pointer to a FILETIME structure that contains the new
creation date and time for the file or directory. This
parameter can be NULL if the application does not need to
change this information.lpLastAccessTime
- A pointer to a FILETIME structure that contains the new last
access date and time for the file or directory. The last
access time includes the last time the file or directory was
written to, read from, or (in the case of executable files)
run. This parameter can be NULL if the application does not
need to change this information.
To preserve the existing last access time for a file even
after accessing a file, call SetFileTime immediately after
opening the file handle with this parameter's FILETIME
structure members initialized to 0xFFFFFFFF.lpLastWriteTime
- A pointer to a FILETIME structure that contains the new last
modified date and time for the file or directory. This
parameter can be NULL if the application does not need to
change this information.
boolean SetFileAttributes(String lpFileName, WinDef.DWORD dwFileAttributes)
lpFileName
- The name of the file whose attributes are to be set.
The name is limited to MAX_PATH characters. To extend this
limit to 32,767 wide characters, prepend "\\?\" to the path.dwFileAttributes
- The file attributes to set for the file. This parameter can be
one or more values, combined using the bitwise-OR operator.
However, all other values override FILE_ATTRIBUTE_NORMAL.
WinDef.DWORD GetLogicalDriveStrings(WinDef.DWORD nBufferLength, char[] lpBuffer)
nBufferLength
- Maximum size of the buffer pointed to by lpBuffer, in TCHARs.
This size does not include the terminating null character. If
this parameter is zero, lpBuffer is not used.lpBuffer
- Pointer to a buffer that receives a series of null-terminated
strings, one for each valid drive in the system, plus with an
additional null character. Each string is a device name.
boolean GetDiskFreeSpaceEx(String lpDirectoryName, WinNT.LARGE_INTEGER lpFreeBytesAvailable, WinNT.LARGE_INTEGER lpTotalNumberOfBytes, WinNT.LARGE_INTEGER lpTotalNumberOfFreeBytes)
lpDirectoryName
- A pointer to a null-terminated string that specifies a
directory on a disk. If this parameter is NULL, the function
uses the root of the current disk. If this parameter is a UNC
name, it must include a trailing backslash, for example,
\\MyServer\MyShare\. This parameter does not have to specify
the root directory on a disk. The function accepts any
directory on a disk.lpFreeBytesAvailable
- A pointer to a variable that receives the total number of free
bytes on a disk that are available to the user who is
associated with the calling thread. This parameter can be
NULL.lpTotalNumberOfBytes
- A pointer to a variable that receives the total number of
bytes on a disk that are available to the user who is
associated with the calling thread. This parameter can be
NULL.lpTotalNumberOfFreeBytes
- A pointer to a variable that receives the total number of free
bytes on a disk. This parameter can be NULL.
boolean DeleteFile(String filename)
filename
- The name of the file to be deleted.
boolean CreatePipe(WinNT.HANDLEByReference hReadPipe, WinNT.HANDLEByReference hWritePipe, WinBase.SECURITY_ATTRIBUTES lpPipeAttributes, int nSize)
hReadPipe
- A pointer to a variable that receives the read handle for the
pipe.hWritePipe
- A pointer to a variable that receives the write handle for the
pipe.lpPipeAttributes
- A pointer to a SECURITY_ATTRIBUTES structure that determines
whether the returned handle can be inherited by child
processes.nSize
- The size of the buffer for the pipe, in bytes.
boolean SetHandleInformation(WinNT.HANDLE hObject, int dwMask, int dwFlags)
hObject
- A handle to an object whose information is to be set.dwMask
- A mask that specifies the bit flags to be changed. Use the
same constants shown in the description of dwFlags.dwFlags
- Set of bit flags that specifies properties of the object
handle.
int GetFileAttributes(String lpFileName)
lpFileName
- The name of the file or directory. Prepend \\?\ to the path
for names up to 32,767 wide characters
int GetFileType(WinNT.HANDLE hFile)
hFile
- A handle to the file.
boolean DeviceIoControl(WinNT.HANDLE hDevice, int dwIoControlCode, Pointer lpInBuffer, int nInBufferSize, Pointer lpOutBuffer, int nOutBufferSize, IntByReference lpBytesReturned, Pointer lpOverlapped)
hDevice
- A handle to the device on which the operation is to be
performed. The device is typically a volume, directory, file,
or stream. To retrieve a device handle, use the CreateFile
function. For more information, see Remarks.dwIoControlCode
- The control code for the operation. This value identifies the
specific operation to be performed and the type of device on
which to perform it. For a list of the control codes, see
Remarks. The documentation for each control code provides
usage details for the lpInBuffer, nInBufferSize, lpOutBuffer,
and nOutBufferSize parameters.lpInBuffer
- A pointer to the input buffer that contains the data required
to perform the operation. The format of this data depends on
the value of the dwIoControlCode parameter. This parameter can
be NULL if dwIoControlCode specifies an operation that does
not require input data.nInBufferSize
- The size of the input buffer, in bytes.lpOutBuffer
- A pointer to the output buffer that is to receive the data
returned by the operation. The format of this data depends on
the value of the dwIoControlCode parameter. This parameter can
be NULL if dwIoControlCode specifies an operation that does
not return data.nOutBufferSize
- The size of the output buffer, in bytes.lpBytesReturned
- A pointer to a variable that receives the size of the data
stored in the output buffer, in bytes. If the output buffer is
too small to receive any data, the call fails, GetLastError
returns ERROR_INSUFFICIENT_BUFFER, and lpBytesReturned is
zero. If the output buffer is too small to hold all of the
data but can hold some entries, some drivers will return as
much data as fits. In this case, the call fails, GetLastError
returns ERROR_MORE_DATA, and lpBytesReturned indicates the
amount of data received. Your application should call
DeviceIoControl again with the same operation, specifying a
new starting point. If lpOverlapped is NULL, lpBytesReturned
cannot be NULL. Even when an operation returns no output data
and lpOutBuffer is NULL, DeviceIoControl makes use of
lpBytesReturned. After such an operation, the value of
lpBytesReturned is meaningless. If lpOverlapped is not NULL,
lpBytesReturned can be NULL. If this parameter is not NULL and
the operation returns data, lpBytesReturned is meaningless
until the overlapped operation has completed. To retrieve the
number of bytes returned, call GetOverlappedResult. If hDevice
is associated with an I/O completion port, you can retrieve
the number of bytes returned by calling
GetQueuedCompletionStatus.lpOverlapped
- A pointer to an OVERLAPPED structure. If hDevice was opened
without specifying FILE_FLAG_OVERLAPPED, lpOverlapped is
ignored. If hDevice was opened with the FILE_FLAG_OVERLAPPED
flag, the operation is performed as an overlapped
(asynchronous) operation. In this case, lpOverlapped must
point to a valid OVERLAPPED structure that contains a handle
to an event object. Otherwise, the function fails in
unpredictable ways. For overlapped operations, DeviceIoControl
returns immediately, and the event object is signaled when the
operation has been completed. Otherwise, the function does not
return until the operation has been completed or an error
occurs.
boolean GetDiskFreeSpaceEx(String lpDirectoryName, LongByReference lpFreeBytesAvailable, LongByReference lpTotalNumberOfBytes, LongByReference lpTotalNumberOfFreeBytes)
lpDirectoryName
- the lp directory namelpFreeBytesAvailable
- the lp free bytes availablelpTotalNumberOfBytes
- the lp total number of byteslpTotalNumberOfFreeBytes
- the lp total number of free bytes
WinNT.HANDLE CreateToolhelp32Snapshot(WinDef.DWORD dwFlags, WinDef.DWORD th32ProcessID)
dwFlags
- The portions of the system to be included in the snapshot.th32ProcessID
- The process identifier of the process to be included in the
snapshot. This parameter can be zero to indicate the current
process. This parameter is used when the TH32CS_SNAPHEAPLIST,
TH32CS_SNAPMODULE, TH32CS_SNAPMODULE32, or TH32CS_SNAPALL
value is specified. Otherwise, it is ignored and all processes
are included in the snapshot.
If the specified process is the Idle process or one of the
CSRSS processes, this function fails and the last error code
is ERROR_ACCESS_DENIED because their access restrictions
prevent user-level code from opening them.
If the specified process is a 64-bit process and the caller is
a 32-bit process, this function fails and the last error code
is ERROR_PARTIAL_COPY (299).
boolean Process32First(WinNT.HANDLE hSnapshot, Tlhelp32.PROCESSENTRY32 lppe)
hSnapshot
- A handle to the snapshot returned from a previous call to the
CreateToolhelp32Snapshot function.lppe
- A pointer to a PROCESSENTRY32 structure. It contains process
information such as the name of the executable file, the
process identifier, and the process identifier of the parent
process.
boolean Process32Next(WinNT.HANDLE hSnapshot, Tlhelp32.PROCESSENTRY32 lppe)
hSnapshot
- A handle to the snapshot returned from a previous call to the
CreateToolhelp32Snapshot function.lppe
- A pointer to a PROCESSENTRY32 structure.
boolean SetEnvironmentVariable(String lpName, String lpValue)
lpName
- Pointer to a string containing the name of the environment
variable to set.lpValue
- Pointer to a string containing the value to set it to. if this
value is NULL, the variable is deleted from the current
process' environment.
int GetEnvironmentVariable(String lpName, char[] lpBuffer, int nSize)
lpName
- The name of the environment variable.lpBuffer
- A pointer to a buffer that receives the contents of the
specified environment variable as a null-terminated string. An
environment variable has a maximum size limit of 32,767
characters, including the null-terminating character.nSize
- The size of the buffer pointed to by the lpBuffer parameter,
including the null-terminating character, in characters.
WinDef.LCID GetSystemDefaultLCID()
WinDef.LCID GetUserDefaultLCID()
int GetPrivateProfileInt(String appName, String keyName, int defaultValue, String fileName)
appName
- The name of the section in the initialization file.keyName
- The name of the key whose value is to be retrieved. This value is in the form of a string; the GetPrivateProfileInt(java.lang.String, java.lang.String, int, java.lang.String)
function converts
the string into an integer and returns the integer.defaultValue
- The default value to return if the key name cannot be found in the initialization file.fileName
- The name of the initialization file. If this parameter does not contain a full path to the file, the system searches for the file in the
Windows directory.
WinDef.DWORD GetPrivateProfileString(String lpAppName, String lpKeyName, String lpDefault, char[] lpReturnedString, WinDef.DWORD nSize, String lpFileName)
lpAppName
- The name of the section containing the key name. If this parameter is null
, the GetPrivateProfileString(java.lang.String, java.lang.String, java.lang.String, char[], com.sun.jna.platform.win32.WinDef.DWORD, java.lang.String)
function copies all
section names in the file to the supplied buffer.lpKeyName
- The name of the key whose associated string is to be retrieved. If this parameter is null
, all key names in the section specified by
the lpAppName
parameter are copied to the buffer specified by the lpReturnedString
parameter.lpDefault
- A default string. If the lpKeyName
key cannot be found in the initialization file, GetPrivateProfileString(java.lang.String, java.lang.String, java.lang.String, char[], com.sun.jna.platform.win32.WinDef.DWORD, java.lang.String)
copies the default
string to the lpReturnedString
buffer. If this parameter is null
, the default is an empty string, ""
.
Avoid specifying a default string with trailing blank characters. The function inserts a null
character in the
lpReturnedString
buffer to strip any trailing blanks.
lpReturnedString
- A pointer to the buffer that receives the retrieved string.nSize
- The size of the buffer pointed to by the lpReturnedString
parameter, in characters.lpFileName
- The name of the initialization file. If this parameter does not contain a full path to the file, the system searches for the file in the
Windows directory.
null
character.
If neither lpAppName
nor lpKeyName
is null
and the supplied destination buffer is too small to hold the requested string,
the string is truncated and followed by a null
character, and the return value is equal to nSize
minus one.
If either lpAppName
or lpKeyName
is null
and the supplied destination buffer is too small to hold all the strings, the
last string is truncated and followed by two null
characters. In this case, the return value is equal to nSize
minus two.
In the event the initialization file specified by lpFileName
is not found, or contains invalid values, this function will set errorno
with a value of '0x2' (File Not Found). To retrieve extended error information, call GetLastError()
.
boolean WritePrivateProfileString(String lpAppName, String lpKeyName, String lpString, String lpFileName)
lpAppName
- The name of the section to which the string will be copied. If the section does not exist, it is created. The name of the section is
case-independent; the string can be any combination of uppercase and lowercase letters.lpKeyName
- The name of the key to be associated with a string. If the key does not exist in the specified section, it is created. If this parameter is
null
, the entire section, including all entries within the section, is deleted.lpString
- A string to be written to the file. If this parameter is null
, the key pointed to by the lpKeyName
parameter is deleted.lpFileName
- The name of the initialization file.
true
.
If the function fails, or if it flushes the cached version of the most recently accessed initialization file, the return value is false
.
To get extended error information, call GetLastError()
.
|
JNA API> 4.0.0 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |