kernel32.dll. Includes additional
alternate mappings from WinNT which make use of NIO buffers,
Wincon for console API.
| Modifier and Type | Field and Description |
|---|---|
| public static final WinDef. | |
| public static final WinDef. | |
| public static final WinDef. | |
| public static final WinDef. | |
| public static final Kernel32 | INSTANCE
The instance. |
| public static final int | LOAD_LIBRARY_AS_DATAFILE
LOAD_LIBRARY_AS_DATAFILE 0x00000002 If this value is used, the system maps the file into the calling process's virtual address space as if it were a data file. |
| public static final int | |
| public static final WinDef. | NORMAL_PRIORITY_CLASS
Process priority classes |
| public static final WinDef. | PROCESS_MODE_BACKGROUND_BEGIN
Process mode flags |
| public static final WinDef. | |
| public static final WinDef. | |
| public static final int | THREAD_MODE_BACKGROUND_BEGIN
Thread mode flags |
| public static final int | |
| public static final int | |
| public static final int | |
| public static final int | THREAD_PRIORITY_ERROR_RETURN
Thread priority error code |
| public static final int | |
| public static final int | THREAD_PRIORITY_IDLE
Thread priorities |
| public static final int | |
| public static final int | |
| public static final int |
| Modifier and Type | Method and Description | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| public boolean | Returns: true if successful, false otherwise.
To get extended error information, call GetLastError().The pipe name. lpNamedPipeName, byte[] The data to be written to the pipe. lpInBuffer, int The size of the write buffer, in bytes. nInBufferSize, byte[] The buffer that receives the data read from the pipe. lpOutBuffer, int The size of the read buffer, in bytes. nOutBufferSize, IntByReference A variable that receives the number of bytes read from
the pipe. lpBytesRead, int The number of milliseconds to wait for the named pipe to
be available. nTimeOut)Connects to a message-type pipe (and waits if an instance of the pipe is not available), writes to and reads from the pipe, and then closes the pipe. | ||||||||||||||||
| public boolean | Returns: If the function succeeds, the return value is nonzero. If the function fails, the return value is zero. To get extended error information, callGetLastError.Handle to an open object. This parameter can be a pseudo
handle or INVALID_HANDLE_VALUE. hObjectCloses an open object handle. | ||||||||||||||||
| public boolean | Returns: If the operation is synchronous, does not return until the operation
has completed. If the function succeeds, the return value is If the operation is asynchronous, returns immediately. If the operation is
still pending, the return value is If a client connects before the function is called, the function returns
A handle to the server end of a named pipe instance. hNamedPipe,A pointer to an lpOverlappedWinBase. structure.Enables a named pipe server process to wait for a client process to connect to an instance of a named pipe | ||||||||||||||||
| public boolean | Returns: If the function succeeds, the return value is nonzero. If the function fails, the return value is zero. To get extended error information, call GetLastError.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. lpExistingFileName, String 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. lpNewFileName, boolean 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. bFailIfExists)Copies an existing file to a new file. | ||||||||||||||||
| public boolean | Returns: If the function succeeds, the return value is nonzero. If the function fails, the return value is zero. To get extended error information, call GetLastError.Pointer to a null-terminated string that specifies the path of
the directory to be created. lpPathName, WinBase.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. lpSecurityAttributesThe CreateDirectory function creates a new directory. | ||||||||||||||||
| public WinNT. | Returns: If the function succeeds, the return value is a handle to the event object. If the named event object existed before the function call, the function returns a handle to the existing object and GetLastError returns ERROR_ALREADY_EXISTS. If the function fails, the return value is NULL. To get extended error information, call GetLastError.A pointer to a SECURITY_ATTRIBUTES structure. If this
parameter is NULL, the handle cannot be inherited by child
processes. lpEventAttributes,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. bManualReset, boolean If this parameter is TRUE, the initial state of the event
object is signaled; otherwise, it is nonsignaled. bInitialState, String The name of the event object. The name is limited to MAX_PATH
characters. Name comparison is case sensitive. lpName)Creates or opens a named or unnamed event object. | ||||||||||||||||
| public WinNT. | Returns: If the function succeeds, the return value is an open handle to a specified file. If a specified file exists before the function call and dwCreationDisposition is CREATE_ALWAYS or OPEN_ALWAYS, a call to GetLastError returns ERROR_ALREADY_EXISTS, even when the function succeeds. If a file does not exist before the call, GetLastError returns 0 (zero). If the function fails, the return value is INVALID_HANDLE_VALUE. To get extended error information, call GetLastError.A pointer to a null-terminated string that specifies the name
of an object to create or open. lpFileName, int The access to the object, which can be read, write, or both. dwDesiredAccess, int The sharing mode of an object, which can be read, write, both,
or none. dwShareMode, WinBase.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. lpSecurityAttributes,An action to take on files that exist and do not exist. dwCreationDisposition, int The file attributes and flags. dwFlagsAndAttributes, WinNT.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. hTemplateFileThe CreateFile function creates or opens a file, file stream, directory, physical disk, volume, console buffer, tape drive, communications resource, mailslot, or named pipe. | ||||||||||||||||
| public WinNT. | Returns: If the function succeeds, the return value is a handle to the newly created file mapping object. If the object exists before the function call, the function returns a handle to the existing object (with its current size, not the specified size), and GetLastError returns ERROR_ALREADY_EXISTS. If the function fails, the return value is NULL. To get extended error information, call GetLastError.A handle to the file from which to create a file mapping
object. hFile,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. lpAttributes,Specifies the page protection of the file mapping object. All
mapped views of the object must be compatible with this
protection. flProtect, int The high-order DWORD of the maximum size of the file mapping
object. dwMaximumSizeHigh, int The low-order DWORD of the maximum size of the file mapping
object. dwMaximumSizeLow, String The name of the file mapping object. lpName)Creates or opens a named or unnamed file mapping object for a specified file. | ||||||||||||||||
| public WinNT. | Returns: If the function succeeds, the return value is the handle to an I/O completion port: If the ExistingCompletionPort parameter was NULL, the return value is a new handle. If the ExistingCompletionPort parameter was a valid I/O completion port handle, the return value is that same handle. If the FileHandle parameter was a valid handle, that file handle is now associated with the returned I/O completion port. If the function fails, the return value is NULL. To get extended error information, call the GetLastError function.An open file handle or INVALID_HANDLE_VALUE. FileHandle,A handle to an existing I/O completion port or NULL. ExistingCompletionPort,The per-handle user-defined completion key that is included in
every I/O completion packet for the specified file handle. CompletionKey, int The maximum number of threads that the operating system can
allow to concurrently process I/O completion packets for the
I/O completion port. 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. | ||||||||||||||||
| public WinNT. | Returns: If the function succeeds, the return value is a handle to the newly created mutex object.
If the function fails, the return value is NULL. To get extended error
information, call If the mutex is a named mutex and the object existed before this function
call, the return value is a handle to the existing object,
A pointer to a lpMutexAttributes,WinBase. structure. If this
parameter is NULL, the mutex handle cannot be inherited by child
processes.
The lpSecurityDescriptor member of the structure specifies a security descriptor for the new mutex. If lpMutexAttributes is NULL, the mutex gets a default security descriptor. The ACLs in the default security descriptor for a mutex come from the primary or impersonation token of the creator. If this value is TRUE and the caller created the mutex, the calling
thread obtains initial ownership of the mutex object. Otherwise, the
calling thread does not obtain ownership of the mutex. To determine if
the caller created the mutex, see the Return Values section. bInitialOwner, String The name of the mutex object. The name is limited to
lpName)WinDef#MAX_PATH characters. Name comparison is case sensitive.
If lpName matches the name of an existing named mutex object, this
function requests the If lpName is NULL, the mutex object is created without a name.
If lpName matches the name of an existing event, semaphore, waitable
timer, job, or file-mapping object, the function fails and the
The name can have a "Global\" or "Local\" prefix to explicitly create the object in the global or session namespace. The remainder of the name can contain any character except the backslash character (\). Creates or opens a named or unnamed mutex object. | ||||||||||||||||
| public WinNT. | Returns: If the function succeeds, the return value is a handle to the server end of a named pipe instance. If the function fails, the return value isINVALID_HANDLE_VALUE.
To get extended error information, call GetLastError().The unique pipe name. This string must have the following form:
lpName, int
The pipename part of the name can include any character other than a backslash,
including numbers and special characters. The entire pipe name string can be up to
The open mode. The function fails if specifies anything other than
0 or the allowed flags dwOpenMode, int The pipe mode. The function fails if specifies anything other than
0 or the allowed flags dwPipeMode, int The maximum number of instances that can be created for this pipe.
Acceptable values are in the range 1 through nMaxInstances, int PIPE_UNLIMITED_INSTANCESThe number of bytes to reserve for the output buffer. nOutBufferSize, int The number of bytes to reserve for the input buffer. nInBufferSize, int The default time-out value, in milliseconds. A value of zero will
result in a default time-out of 50 milliseconds nDefaultTimeOut, WinBase.A pointer to a lpSecurityAttributesWinBase. structure that
specifies a security descriptor for the new named pipe. If null the named pipe
gets a default security descriptor and the handle cannot be inherited.
| ||||||||||||||||
| public boolean | Returns: If the function succeeds, the return value is nonzero. If the function fails, the return value is zero. To get extended error information, call GetLastError.A pointer to a variable that receives the read handle for the
pipe. hReadPipe,A pointer to a variable that receives the write handle for the
pipe. hWritePipe,A pointer to a SECURITY_ATTRIBUTES structure that determines
whether the returned handle can be inherited by child
processes. lpPipeAttributes,The size of the buffer for the pipe, in bytes. nSize)Creates an anonymous pipe, and returns handles to the read and write ends of the pipe. | ||||||||||||||||
| public boolean | Returns: If the function succeeds, the return value is nonzero.The name of the module to be executed. lpApplicationName, String The command line to be executed. lpCommandLine, WinBase.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. lpProcessAttributes,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. lpThreadAttributes,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. bInheritHandles, WinDef.The flags that control the priority class and the creation of
the process. dwCreationFlags,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. lpEnvironment, String The full path to the current directory for the process. lpCurrentDirectory, WinBase.A pointer to a STARTUPINFO or STARTUPINFOEX structure. lpStartupInfo,A pointer to a PROCESS_INFORMATION structure that receives
identification information about the new process. lpProcessInformationCreates a new process and its primary thread. | ||||||||||||||||
| public boolean | Returns: If the function succeeds, the return value is nonzero.The name of the module to be executed. lpApplicationName, char[] 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.
lpCommandLine, WinBase.
The Unicode version of this function, 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:
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. lpProcessAttributes,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. lpThreadAttributes,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. bInheritHandles, WinDef.The flags that control the priority class and the creation of
the process. dwCreationFlags,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. lpEnvironment, String The full path to the current directory for the process. lpCurrentDirectory, WinBase.A pointer to a STARTUPINFO or STARTUPINFOEX structure. lpStartupInfo,A pointer to a PROCESS_INFORMATION structure that receives
identification information about the new process. lpProcessInformationCreates a new process and its primary thread. | ||||||||||||||||
| public WinNT. | CreateRemoteThread(WinNT.
| ||||||||||||||||
| public WinNT. | Returns: If the function succeeds, the return value is a handle to the new thread. If the function fails, the return value isnull. To get extended
error information, call GetLastError().A handle to the process in which the thread is to be created. hProcess,The lpThreadAttributes,WinBase. structure that
specifies a security descriptor for the new thread. If null, the
thread gets a default security descriptor and the handle cannot be inherited.The initial size of the stack, in bytes. The system rounds
this value to the nearest page. If this parameter is 0 (zero), the new thread
uses the default size for the executable. dwStackSize, Pointer The application-defined lpStartAddress, Pointer WinBase.
to be executed by the thread and represents the starting address of the
thread in the remote process. The function must exist in the remote process.A pointer to a variable to be passed to the thread function. lpParameter, int The flags that control the creation of the thread. dwCreationFlags, WinDef.A variable that receives the thread identifier. If this
parameter is lpThreadIdnull, the thread identifier is not returned.Creates a thread that runs in the virtual address space of another process. | ||||||||||||||||
| public WinNT. | Returns: If the function succeeds, it returns an open handle to the specified snapshot. If the function fails, it returns INVALID_HANDLE_VALUE. To get extended error information, call GetLastError. Possible error codes include ERROR_BAD_LENGTH.The portions of the system to be included in the snapshot. dwFlags,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). th32ProcessIDTakes a snapshot of the specified processes, as well as the heaps, modules, and threads used by these processes. | ||||||||||||||||
| public boolean | DefineDosDevice(int
The controllable aspects of the function - see the
various dwFlags, String DDD_XXX constantsThe MS-DOS device name string specifying the device
the function is defining, redefining, or deleting. The device name string
must not have a colon as the last character, unless a drive letter is
being defined, redefined, or deleted. For example, drive lpDeviceName, String C would
be the string "C:". In no case is a trailing backslash
("\") allowed.The path string that will implement this device.
The string is an MS-DOS path string unless the lpTargetPath)DDD_RAW_TARGET_PATH
flag is specified, in which case this string is a path string.Defines, redefines, or deletes MS-DOS device names. | ||||||||||||||||
| public boolean | Returns: If the function succeeds, the return value is nonzero. If the function fails, the return value is zero (0). To get extended error information, call GetLastError.The name of the file to be deleted. filename)Deletes an existing file. | ||||||||||||||||
| public boolean | DeleteVolumeMountPoint(String
The drive letter or mounted folder to be deleted.
A trailing backslash is required, for example, "X:\" or "Y:\MountX\". lpszVolumeMountPoint)Deletes a drive letter or mounted folder | ||||||||||||||||
| public boolean | Returns: If the function succeeds, the return value is nonzero. If the function fails, the return value is zero. To get extended error information, call GetLastError.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. hDevice,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. dwIoControlCode, Pointer 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. lpInBuffer, int The size of the input buffer, in bytes. nInBufferSize, Pointer 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. lpOutBuffer, int The size of the output buffer, in bytes. nOutBufferSize, IntByReference 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. lpBytesReturned, Pointer 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. lpOverlapped)Sends a control code directly to a specified device driver, causing the corresponding device to perform the corresponding operation. | ||||||||||||||||
| public boolean | Returns: true if successful, false otherwise.
To get extended error information, call GetLastError().A handle to an instance of a named pipe. hNamedPipeDisconnects the server end of a named pipe instance from a client process. | ||||||||||||||||
| public boolean | Returns: If the function succeeds, the return value is nonzero. If the function fails, the return value is zero. To get extended error information, call GetLastError.Handle to the process with the handle to duplicate. The handle
must have the PROCESS_DUP_HANDLE access right. hSourceProcessHandle,Handle to duplicate. This is an open object handle that is
valid in the context of the source process. hSourceHandle,Handle to the process that is to receive the duplicated
handle. The handle must have the PROCESS_DUP_HANDLE access
right. hTargetProcessHandle,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. lpTargetHandle,Access requested for the new handle. dwDesiredAccess, boolean Indicates whether the handle is inheritable. bInheritHandle, int Optional actions. dwOptions)The DuplicateHandle function duplicates an object handle. | ||||||||||||||||
| public boolean | Returns: The return value is TRUE if the function succeeds or FALSE if the function does not find a resource of the type specified, or if the function fails for another reason. To get extended error information, call GetLastError.A handle to a module to be searched. hModule,Starting with Windows Vista, if this is an LN file, then appropriate .mui files (if any exist) are included in the search. If this parameter is NULL, that is equivalent to passing in a handle to the module used to create the current process. The type of the resource for which the name is being
enumerated. type, WinBase.Alternately, rather than a pointer, this parameter can be MAKEINTRESOURCE(ID), where ID is an integer value representing a predefined resource type. For a list of predefined resource types, see Resource Types. For more information, see the Remarks section below. A pointer to the callback function to be called for each
enumerated resource name or ID. For more information, see
EnumResNameProc. proc,An application-defined value passed to the callback function.
This parameter can be used in error checking. lParam)Enumerates resources of a specified type within a binary module. | ||||||||||||||||
| public boolean | Returns: Returns TRUE if successful; otherwise, FALSE. To get extended error information, call GetLastError.A handle to a module to be searched. hModule,This handle must be obtained through LoadLibrary or LoadLibraryEx. See Remarks for more information. If this parameter is NULL, that is equivalent to passing in a handle to the module used to create the current process. A pointer to the callback function to be called for each
enumerated resource type. proc,For more information, see the EnumResTypeProc function. An application-defined value passed to the callback function. lParam)Enumerates resource types within a binary module. | ||||||||||||||||
| public void | |||||||||||||||||
| public int | Returns: If the function succeeds, the return value is the number of TCHARs stored in the destination buffer, including the terminating null character. If the destination buffer is too small to hold the expanded string, the return value is the required buffer size, in characters.If the function fails, the return value is zero. To get extended error information, call GetLastError. A buffer that contains one or more environment-variable
strings in the form: %variableName%. For each such
reference, the %variableName% portion is replaced with the
current value of that environment variable.
lpSrc, Pointer Case is ignored when looking up the environment-variable name. If the name is not found, the %variableName% portion is left unexpanded. Note that this function does not support all the features that Cmd.exe supports. For example, it does not support %variableName:str1=str2% or %variableName:~offset,length%. A pointer to a buffer that receives the result of expanding
the environment variable strings in the lpSrc buffer. Note
that this buffer cannot be the same as the lpSrc buffer. lpDst, int The maximum number of characters that can be stored in the
buffer pointed to by the lpDst parameter. When using ANSI
strings, the buffer size should be the string length, plus
terminating null character, plus one. When using Unicode
strings, the buffer size should be the string length plus
the terminating null character. nSize)Expands environment-variable strings and replaces them with the values defined for the current user. | ||||||||||||||||
| public boolean | Returns: If the function succeeds, the return value is nonzero. If the function fails, the return value is zero. To get extended error information, call GetLastError.[in] A pointer to a FILETIME structure containing the
UTC-based file time to be converted into a local file time. lpFileTime,[out] A pointer to a FILETIME structure to receive the
converted local file time. This parameter cannot be the same
as the lpFileTime parameter. lpLocalFileTimeConverts a file time to a local file time. | ||||||||||||||||
| public boolean | Returns: If the function succeeds, the return value is nonzero. If the function fails, the return value is zero. To get extended error information, call GetLastError.[in] A pointer to a FILETIME structure containing the file time to be converted to system (UTC) date and time format.
This value must be less than 0x8000000000000000. Otherwise, the function fails. lpFileTime,A pointer to a SYSTEMTIME structure to receive the converted file time. lpSystemTimeConverts a file time to system time format. | ||||||||||||||||
| public boolean | Returns: If the function succeeds, the return value is nonzero. If the function fails, the return value is zero. To get extended error information, call GetLastError.The file search handle. hFindFileCloses a file search handle opened by the FindFirstFile, FindFirstFileEx, FindFirstFileNameW, FindFirstFileNameTransactedW, FindFirstFileTransacted, FindFirstStreamTransactedW, or FindFirstStreamW functions. | ||||||||||||||||
| public WinNT. | Returns: If the function succeeds, the return value is a search handle used in a subsequent call to FindNextFile or FindClose, and the lpFindFileData parameter contains information about the first file or directory found. If the function fails or fails to locate files from the search string in the lpFileName parameter, the return value is INVALID_HANDLE_VALUE and the contents of lpFindFileData are indeterminate. To get extended error information, call the GetLastError function. If the function fails because no matching files can be found, the GetLastError function returns ERROR_FILE_NOT_FOUND.The directory or path, and the file name. The file name can include wildcard characters,
for example, an asterisk (*) or a question mark (?).
This parameter should not be NULL, an invalid string (for example, an empty string or a string that is
missing the terminating null character), or end in a trailing backslash (\).
If the string ends with a wildcard, period, or directory name, the user must have access to the root
and all subdirectories on the path.
In the ANSI version of this function, the name is limited to MAX_PATH characters. To extend this
limit to approximately 32,000 wide characters, call the Unicode version of the function (FindFirstFileExW),
and prepend "\\?\" to the path. For more information, see Naming a File.
Tip Starting in Windows 10, version 1607, for the unicode version of this function (FindFirstFileExW),
you can opt-in to remove the MAX_PATH character limitation without prepending "\\?\".
See the "Maximum Path Limitation" section of Naming Files, Paths, and Namespaces for details. lpFileName, Pointer A pointer to the buffer that receives the file data. The pointer type is determined by the level of
information that is specified in the fInfoLevelId parameter. lpFindFileData)Searches a directory for a file or subdirectory with a name that matches a specific name (or partial name if wildcards are used). | ||||||||||||||||
| public WinNT. | Returns: If the function succeeds, the return value is a search handle used in a subsequent call to FindNextFile or FindClose, and the lpFindFileData parameter contains information about the first file or directory found. If the function fails or fails to locate files from the search string in the lpFileName parameter, the return value is INVALID_HANDLE_VALUE and the contents of lpFindFileData are indeterminate. To get extended error information, call the GetLastError function. If the function fails because no matching files can be found, the GetLastError function returns ERROR_FILE_NOT_FOUND.The directory or path, and the file name. The file name can include wildcard characters,
for example, an asterisk (*) or a question mark (?).
This parameter should not be NULL, an invalid string (for example, an empty string or a string that is
missing the terminating null character), or end in a trailing backslash (\).
If the string ends with a wildcard, period, or directory name, the user must have access to the root
and all subdirectories on the path.
In the ANSI version of this function, the name is limited to MAX_PATH characters. To extend this
limit to approximately 32,000 wide characters, call the Unicode version of the function (FindFirstFileExW),
and prepend "\\?\" to the path. For more information, see Naming a File.
Tip Starting in Windows 10, version 1607, for the unicode version of this function (FindFirstFileExW),
you can opt-in to remove the MAX_PATH character limitation without prepending "\\?\".
See the "Maximum Path Limitation" section of Naming Files, Paths, and Namespaces for details. lpFileName, int The information level of the returned data. This parameter is one of the FINDEX_INFO_LEVELS enumeration values. fInfoLevelId, Pointer A pointer to the buffer that receives the file data. The pointer type is determined by the level of
information that is specified in the fInfoLevelId parameter. lpFindFileData, int The type of filtering to perform that is different from wildcard matching. This parameter is one of
the FINDEX_SEARCH_OPS enumeration values. fSearchOp, Pointer A pointer to the search criteria if the specified fSearchOp needs structured search information.
At this time, none of the supported fSearchOp values require extended search information. Therefore,
this pointer must be NULL. lpSearchFilter, WinDef.Specifies additional flags that control the search.
FIND_FIRST_EX_CASE_SENSITIVE (0x01) - Searches are case-sensitive.
FIND_FIRST_EX_LARGE_FETCH (0x02) - Uses a larger buffer for directory queries, which can increase performance
of the find operation. Windows Server 2008, Windows Vista, Windows Server 2003 and Windows XP: This value
is not supported until Windows Server 2008 R2 and Windows 7. dwAdditionalFlagsSearches a directory for a file or subdirectory with a name and attributes that match those specified. | ||||||||||||||||
| public WinNT. | Returns: If the function succeeds, the return value is a search handle used in a subsequent call to theFindNextVolume(com.
and FindVolumeClose(com. functions.
Otherwise, the return value is the INVALID_HANDLE_VALUE. To get
extended error information, call GetLastError().A buffer that receives a null-terminated string that
specifies a volume GUID path for the first volume that is found lpszVolumeName, int The length of the buffer to receive the volume GUID path cchBufferLength)Retrieves the name of a volume on a computer - used to begin scanning the volumes of a computer | ||||||||||||||||
| public WinNT. | Returns: If succeeds, a search handle used in a subsequent call to the FindNextVolumeMountPoint and FindVolumeMountPointClose functions. Otherwise, the return value is theINVALID_HANDLE_VALUE.
To get extended error information, call GetLastError().A volume GUID path for the volume to scan for
mounted folders. A trailing backslash is required. lpszRootPathName, char[] A buffer that receives the name of the first
mounted folder that is found. lpszVolumeMountPoint, int The length of the buffer that receives the path
to the mounted folder cchBufferLength)Retrieves the name of a mounted folder on the specified volume - used to begin scanning the mounted folders on a volume | ||||||||||||||||
| public boolean | Returns: If the function succeeds, the return value is nonzero and the lpFindFileData parameter contains information about the next file or directory found. If the function fails, the return value is zero and the contents of lpFindFileData are indeterminate. To get extended error information, call the GetLastError function. If the function fails because no more matching files can be found, the GetLastError function returns ERROR_NO_MORE_FILES.The search handle returned by a previous call to the FindFirstFile or FindFirstFileEx function. hFindFile,A pointer to the WIN32_FIND_DATA structure that receives information about the found file or subdirectory. lpFindFileData)Continues a file search from a previous call to the FindFirstFile, FindFirstFileEx, or FindFirstFileTransacted functions. | ||||||||||||||||
| public boolean | Returns: true if succeeds. If fails then call GetLastError()
to get extended error information. If no more volumes found then the reported
error is ERROR_NO_MORE_FILES. In this case, simply call FindVolumeClose(com.The volume search handle returned by a previous call to the
hFindVolume,FindFirstVolume(char[], int).A buffer that receives a null-terminated string that
specifies a volume GUID path for the (next) path that is found lpszVolumeName, int The length of the buffer to receive the volume GUID path cchBufferLength)Continues a volume search started by a call to the | ||||||||||||||||
| public boolean | Returns: true if succeeds. If fails then call GetLastError()
to get extended error information. If no more mount points found then the reported
error is ERROR_NO_MORE_FILES. In this case, simply call
FindVolumeMountPointClose(com.A mounted folder search handle returned by
a previous call to the hFindVolumeMountPoint,FindFirstVolumeMountPoint(String, char[], int)
function.A buffer that receives the name of the (next)
mounted folder that is found. lpszVolumeMountPoint, int The length of the buffer that receives the path
to the mounted folder cchBufferLength)Continues a mounted folder search started by a call to the
| ||||||||||||||||
| public WinDef. | Returns: If the function succeeds, the return value is a handle to the specified resource's information block.To obtain a handle to the resource, pass this handle to the LoadResource function. If the function fails, the return value is NULL. To get extended error information, call GetLastError. A handle to the module whose portable executable file or an
accompanying MUI file contains the resource. hModule,If this parameter is NULL, the function searches the module used to create the current process. The name of the resource. name, Pointer Alternately, rather than a pointer, this parameter can be MAKEINTRESOURCE(ID), where ID is the integer identifier of the resource. For more information, see the Remarks section below. The resource type. type)Alternately, rather than a pointer, this parameter can be MAKEINTRESOURCE(ID), where ID is the integer identifier of the given resource type. For standard resource types, see Resource Types. For more information, see the Remarks section below. Determines the location of a resource with the specified type and name in the specified module. | ||||||||||||||||
| public boolean | FindVolumeClose(WinNT.
The volume search handle returned by a previous call to the
hFindVolumeFindFirstVolume(char[], int).Closes the specified volume search handle. | ||||||||||||||||
| public boolean | FindVolumeMountPointClose(WinNT.
A mounted folder search handle returned by
a previous call to the hFindVolumeMountPointFindFirstVolumeMountPoint(String, char[], int)
function.Closes the specified mounted folder search handle. | ||||||||||||||||
| public boolean | Returns: true if successful, false otherwise.
To get extended error information, call GetLastError().A handle to the open file. If a handle to a communications
device, the function only flushes the transmit buffer. If a handle to the
server end of a named pipe, the function does not return until the client
has read all buffered data from the pipe. hFileFlushes the buffers of a specified file and causes all buffered data to be written to a file. | ||||||||||||||||
| public int | Returns: If the function succeeds, the return value is the number of TCHARs stored in the output buffer, excluding the terminating null character. If the function fails, the return value is zero. To get extended error information, call GetLastError.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.
dwFlags, Pointer This version of the function assumes FORMAT_MESSAGE_ALLOCATE_BUFFER is set. Location of the message definition. lpSource, int Message identifier for the requested message. dwMessageId, int Language identifier for the requested message. dwLanguageId, PointerByReference Pointer to a pointer that receives the allocated buffer in
which the null-terminated string that specifies the formatted
message is written. lpBuffer, int This parameter specifies the minimum number of TCHARs to
allocate for an output buffer. nSize, Pointer Pointer to an array of values that are used as insert values
in the formatted message. va_list)The FormatMessage function formats a message string. | ||||||||||||||||
| public boolean | Returns: true if successful, false otherwise.
To get extended error information, call GetLastError().A pointer to a block of environment strings
obtained by calling the lpszEnvironmentBlock)GetEnvironmentStrings() function
| ||||||||||||||||
| public boolean | Returns: If the function succeeds, the return value is nonzero. If the function fails, the return value is zero. To get extended error information, call the GetLastError function.A handle to the loaded library module. The LoadLibrary,
LoadLibraryEx, GetModuleHandle, or GetModuleHandleEx function
returns this handle. moduleFrees the loaded dynamic-link library (DLL) module and, if necessary, decrements its reference count. | ||||||||||||||||
| public WinNT. | Returns: This function returns S_OK on success or one of the following error codes.
A handle to the process. This handle must have the
PROCESS_VM_READ access right. hProcess,A pointer to a buffer that receives the restart
command line specified by the application when it
called the RegisterApplicationRestart function. The
maximum size of the command line, in characters, is
RESTART_MAX_CMD_LINE. Can be NULL if pcchSize is
zero. pwzCommandline, IntByReference On input, specifies the size of the pwzCommandLine
buffer, in characters.
pcchSize, IntByReference If the buffer is not large enough to receive the command line, the function fails with HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER) and sets this parameter to the required buffer size, in characters. On output, specifies the size of the buffer that was used. To determine the required buffer size, set pwzCommandLine to NULL and this parameter to zero. The size includes one for the null-terminator character. Note that the function returns S_OK, not HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER) in this case. A pointer to a variable that receives the flags
specified by the application when it called the
RegisterApplicationRestart function. pdwFlags)Retrieves the restart information registered for the specified process. | ||||||||||||||||
| public boolean | Returns: If the function succeeds, the return value is nonzero.If the function fails, the return value is zero. To get extended error information, call Kernel32#GetLastError().[in] A handle to the communications device. hFile,The com.
function returns this WinNT..[in, out] A pointer to a lpDCBWinBase. structure that
receives the control settings information.Retrieves the current control settings for a specified communications device. | ||||||||||||||||
| public boolean | Returns: If the function succeeds, the return value is nonzero. If the function fails, the return value is zero. To get extended error information, callKernel32#GetLastError().[in] A handle to the communications device. The
hFile,com.
function returns this handle.[in] A pointer to a lpCommTimeoutsWinBase. structure in
which the time-out information is returned.Retrieves the time-out parameters for all read and write operations on a specified communications device. | ||||||||||||||||
| public boolean | Returns: If the function succeeds, the return value is a nonzero value. If the function fails, the return value is zero. To get extended error information, call GetLastError.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. buffer, IntByReference 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. lpnSize)Retrieves only the NetBIOS name of the local computer. | ||||||||||||||||
| public boolean | Returns: If the function succeeds, the return value is a nonzero value. If the function fails, the return value is zero. To get extended error information, call GetLastError.An enumeration value specifying the type of name to be
retrieved - this parameter is a value from the
COMPUTER_NAME_FORMAT in the WinBase definitions nameType, char[] A pointer to a buffer that receives the computer name or the
cluster virtual server name. The length of the name may
be greater than MAX_COMPUTERNAME_LENGTH characters because DNS
allows longer names. To ensure that this buffer is large enough,
set this parameter to NULL and use the required buffer size
returned in the lpnSize parameter. buffer, IntByReference 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. lpnSize)Retrieves a NetBIOS or DNS name associated with the local computer,
according to the | ||||||||||||||||
| public WinNT. | Returns: The return value is a pseudohandle to the current process.This function returns a pseudohandle for the current process. | ||||||||||||||||
| public int | Returns: The return value is the process identifier of the calling process.This function returns the process identifier of the calling process. | ||||||||||||||||
| public WinNT. | Returns: The return value is a pseudo handle for the current thread.The GetCurrentThread function retrieves a pseudo handle for the current thread. | ||||||||||||||||
| public int | Returns: The return value is the thread identifier of the calling thread.The GetCurrentThreadId function retrieves the thread identifier of the calling thread. | ||||||||||||||||
| public boolean | GetDiskFreeSpace(String
The root directory of the disk for which information is to be
returned. 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\").
Furthermore, a drive specification must have a trailing backslash
(for example, "C:\"). The calling application must
have FILE_LIST_DIRECTORY access rights for this directory. lpRootPathName, WinDef.A variable that receives the number of sectors per cluster. lpSectorsPerCluster,A variable that receives the number of bytes per sector. lpBytesPerSector,A variable that receives the total number of free clusters on the
disk that are available to the user who is associated with the
calling thread. If per-user disk quotas are in use, this value
may be less than the total number of free clusters on the disk. lpNumberOfFreeClusters,A variable that receives the total number of clusters on the
disk that are available to the user who is associated with the
calling thread. If per-user disk quotas are in use, this value
may be less than the total number of clusters on the disk. lpTotalNumberOfClustersRetrieves information about the specified disk, including the amount of free space on the disk | ||||||||||||||||
| public boolean | GetDiskFreeSpaceEx(String
A 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,
lpDirectoryName, WinNT.\\MyServer\MyShare\. This parameter does not have to specify
the root directory on a disk. The function accepts any
directory on a disk.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. lpFreeBytesAvailable,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. lpTotalNumberOfBytes,A pointer to a variable that receives the total number of free
bytes on a disk. This parameter can be NULL. lpTotalNumberOfFreeBytesThe 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. | ||||||||||||||||
| public int | Returns: The return value specifies the type of drive.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. lpRootPathName)Determines whether a disk drive is a removable, fixed, CD-ROM, RAM disk, or network drive. | ||||||||||||||||
| public Pointer | Returns: If the function succeeds, the return value is aPointer.
to the environment block of the current process. If fails, then
null is returned. When the data is no longer needed the memory
block must be released using FreeEnvironmentStrings(Pointer)Retrieves the environment variables for the current process. | ||||||||||||||||
| public int | Returns: If the function succeeds, the return value is the number of characters stored in the buffer pointed to by lpBuffer, not including the terminating null character. If lpBuffer is not large enough to hold the data, the return value is the buffer size, in characters, required to hold the string and its terminating null character and the contents of lpBuffer are undefined. If the function fails, the return value is zero. To get extended error information, call GetLastError.The name of the environment variable. lpName, char[] 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. lpBuffer, int The size of the buffer pointed to by the lpBuffer parameter,
including the null-terminating character, in characters. nSize)Retrieves the contents of the specified variable from the environment block of the calling process. | ||||||||||||||||
| public boolean | Returns: If the function succeeds, the return value is nonzero. If the function fails, the return value is zero. To get extended error information, call GetLastError.A handle to the process. hProcess,A pointer to a variable to receive the process termination status. lpExitCode)Retrieves the termination status of the specified process. | ||||||||||||||||
| public boolean | Returns: If the function succeeds, the return value is nonzero.If the function fails, the return value is zero. A handle to the thread.
hThread,The handle must have the THREAD_QUERY_INFORMATION or THREAD_QUERY_LIMITED_INFORMATION access right. Windows Server 2003 and Windows XP: The handle must have the THREAD_QUERY_INFORMATION access right. A pointer to a variable to receive the thread termination
status. For more information, see Remarks. exitCode)Retrieves the termination status of the specified thread. | ||||||||||||||||
| public int | Returns: INVALID_FILE_ATTRIBUTES if the function fails, otherwise the file attributes WinNT.FILE_ATTRIBUTE_*The name of the file or directory. Prepend \\?\ to the path
for names up to 32,767 wide characters lpFileName)Retrieves file system attributes for a specified file or directory. | ||||||||||||||||
| public boolean | Returns: If the function succeeds, the return value is nonzero and file information data is contained in the buffer pointed to by the lpFileInformation parameter. If the function fails, the return value is zero. To get extended error information, call GetLastError.A handle to the file that contains the information to be retrieved. hFile,A FILE_INFO_BY_HANDLE_CLASS enumeration value that specifies the type of
information to be retrieved. FileInformationClass, Pointer A pointer to the buffer that receives the requested file information.
The structure that is returned corresponds to the class that is specified
by FileInformationClass. lpFileInformation, WinDef.The size of the lpFileInformation buffer, in bytes. dwBufferSizeRetrieves file information for the specified file. | ||||||||||||||||
| public boolean | Returns: If the function succeeds, the return value is nonzero. If the function fails, the return value is zero. To get extended error information, call GetLastError.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. hFile,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. lpCreationTime,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. lpLastAccessTime,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. lpLastWriteTimeRetrieves the date and time that a file or directory was created, last accessed, and last modified. | ||||||||||||||||
| public int | Returns: FILE_TYPE_UNKNOWN if the function fails, or if the type is unknown. You can distinguish between a "valid" return of FILE_TYPE_UNKNOWN and its return due to a calling error (for example, passing an invalid handle to GetFileType) by calling GetLastError. If the function worked properly and FILE_TYPE_UNKNOWN was returned, a call to GetLastError will return NO_ERROR.A handle to the file. hFileRetrieves the file type of the specified file. | ||||||||||||||||
| public int | Returns: The return value is the calling thread's last-error code value.The GetLastError function retrieves the calling thread's last-error code value. | ||||||||||||||||
| public void | GetLocalTime(WinBase.
A pointer to a lpSystemTimeWinBase. structure to receive the current
local date and time.Retrieves the current local date and time. | ||||||||||||||||
| public WinDef. | Returns: If the function succeeds, the return value is the length, in characters, of the strings copied to the buffer, not including the terminating null character. Note that an ANSI-ASCII null character uses one byte, but a Unicode null character uses two bytes. If the buffer is not large enough, the return value is greater than nBufferLength. It is the size of the buffer required to hold the drive strings. If the function fails, the return value is zero. To get extended error information, use the GetLastError function.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. nBufferLength,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. lpBuffer)The GetLogicalDriveStrings function fills a buffer with strings that specify valid drives in the system. | ||||||||||||||||
| public boolean | GetLogicalProcessorInformation(Pointer
a buffer which receives an array of
buffer, WinDef.WinNT. structures.on input, specifies the length of the buffer in bytes. On
output, receives the number of bytes actually returned, or if
returnLengthGetLastError() returned
WinError#ERROR_INSUFFICIENT_BUFFER, the number of
bytes wanted for the call to work.Retrieves information about logical processors and related hardware. | ||||||||||||||||
| public boolean | Returns: If the function succeeds, the return value isTRUE and at
least one WinNT.
structure is written to the output buffer.
If the function fails, the return value is The type of relationship to retrieve. This parameter can be
one of the following values:
relationshipType, Pointer com.,
com.,
com.,
com.,
com.,
or com.A pointer to a buffer that receives an array of
buffer, WinDef.WinNT.
structures. If the function fails, the contents of this buffer
are undefined.On input, specifies the length of the buffer pointed to by
Buffer, in bytes. If the buffer is large enough to contain all
of the data, this function succeeds and ReturnedLength is set
to the number of bytes returned. If the buffer is not large
enough to contain all of the data, the function fails,
GetLastError returns
returnedLengthWinError#ERROR_INSUFFICIENT_BUFFER, and ReturnedLength
is set to the buffer length required to contain all of the
data. If the function fails with an error other than
WinError#ERROR_INSUFFICIENT_BUFFER, the value of
ReturnedLength is undefined.Retrieves information about the relationships of logical processors and related hardware. | ||||||||||||||||
| public WinDef. | Returns: If the function succeeds, the return value is a handle to the specified module. If the function fails, the return value is NULL. To get extended error information, call GetLastError.Pointer to a null-terminated string that contains the name of
the module (either a .dll or .exe file). 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. | ||||||||||||||||
| public boolean | Returns: true if successful, false otherwise.
To get extended error information, call GetLastError().A handle to an instance of a named pipe. Pipe,The buffer to receive the computer name ClientComputerName, int Note use The size of the ClientComputerName
buffer, in bytes. ClientComputerNameLength)Retrieves the client computer name for the specified named pipe. | ||||||||||||||||
| public boolean | Returns: true if successful, false otherwise.
To get extended error information, call GetLastError().A handle to an instance of a named pipe. Pipe,Recipient of the process identifier ClientProcessId
| ||||||||||||||||
| public boolean | Returns: true if successful, false otherwise.
To get extended error information, call GetLastError().A handle to an instance of a named pipe. Pipe,Recipient of the session identifier ClientSessionId
| ||||||||||||||||
| public boolean | Returns: true if successful, false otherwise.
To get extended error information, call GetLastError().A handle to the named pipe for which information is wanted. hNamedPipe,A pointer to a variable that indicates the current
state of the handle. This parameter can be lpState, IntByReference null if this information
is not needed.A pointer to a variable that receives the number
of current pipe instances. This parameter can be lpCurInstances, IntByReference null if this
information is not needed.A pointer to a variable that receives the
maximum number of bytes to be collected on the client's computer before
transmission to the server. This parameter can be lpMaxCollectionCount, IntByReference null if this
information is not needed.A pointer to a variable that receives the
maximum time, in milliseconds, that can pass before a remote named pipe
transfers information over the network. This parameter can be lpCollectDataTimeout, char[] null
if this information is not needed.A buffer that receives the user name string associated
with the client application. This parameter can be lpUserName, int null if this
information is not needed.The size of the buffer specified by the lpUserName
parameter. This parameter is ignored if lpUserName is nMaxUserNameSize)null.Retrieves information about a specified named pipe. | ||||||||||||||||
| public boolean | Returns: true if successful, false otherwise.
To get extended error information, call GetLastError().A handle to the named pipe instance. hNamedPipe,A pointer to a variable that receives the type of the
named pipe. This parameter can be lpFlags, IntByReference null if this information is
not needed.A pointer to a variable that receives the size
of the buffer for outgoing data, in bytes. This parameter can be
lpOutBufferSize, IntByReference null if this information is not needed.A pointer to a variable that receives the size of
the buffer for incoming data, in bytes. This parameter can be lpInBufferSize, IntByReference null
if this information is not needed.A pointer to a variable that receives the maximum
number of pipe instances that can be created. This parameter can be lpMaxInstances)null
if this information is not needed.Retrieves information about the specified named pipe. | ||||||||||||||||
| public boolean | Returns: true if successful, false otherwise.
To get extended error information, call GetLastError().A handle to an instance of a named pipe. Pipe,Recipient of the process identifier. ServerProcessId
| ||||||||||||||||
| public boolean | Returns: true if successful, false otherwise.
To get extended error information, call GetLastError().A handle to an instance of a named pipe. Pipe,session identifier. ServerSessionId
| ||||||||||||||||
| public void | GetNativeSystemInfo(WinBase.
Pointer to a SYSTEM_INFO structure that receives the
information. lpSystemInfoThe GetNativeSystemInfo function retrieves information about the current system to an application running under WOW64. | ||||||||||||||||
| public WinDef. | Returns: If the function succeeds, the return value is the priority class of the specified process.If the function fails, the return value is zero. A handle to the process. hProcessGets the priority class of the specified process. | ||||||||||||||||
| public int | Returns: The return value is the integer equivalent of the string following the specified key name in the specified initialization file. If the key is not found, the return value is the specified default value.The name of the section in the initialization file. appName, String The name of the key whose value is to be retrieved. This value
is in the form of a string; the keyName, int GetPrivateProfileInt
function converts the string into an integer and returns the
integer.The default value to return if the key name cannot be found in
the initialization file. defaultValue, String 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. fileName)Retrieves an integer associated with a key in the specified section of an initialization file. | ||||||||||||||||
| public WinDef. | Returns: The number of characters copied to the buffer, not including the terminating null character. If the buffer is not large enough to contain all the key name and value pairs associated with the named section, the return value is equal tonSize minus
two.The name of the section in the initialization file. lpAppName, char[] A buffer that receives the key name and value pairs associated
with the named section. The buffer is filled with one or more
lpReturnedString, WinDef.null -terminated strings; the last string is followed
by a second null character.The size of the buffer pointed to by the
nSize,lpReturnedString parameter, in characters. The maximum
profile section size is 32,767 characters.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. lpFileName)Retrieves all the keys and values for the specified section of an initialization file. | ||||||||||||||||
| public WinDef. | Returns: The return value specifies the number of characters copied to the specified buffer, not including the terminatingnull
character. If the buffer is not large enough to contain all the
section names associated with the specified initialization file,
the return value is equal to the size specified by nSize
minus two.A pointer to a buffer that receives the section names
associated with the named file. The buffer is filled with one
or more lpszReturnBuffer, WinDef.null -terminated strings; the last string is
followed by a second null character.size of the buffer pointed to by the nSize,lpszReturnBuffer
parameter, in characters.The name of the initialization file. If this parameter is
lpFileName)NULL, the function searches the Win.ini file. If this
parameter does not contain a full path to the file, the system
searches for the file in the Windows directory.Retrieves the names of all sections in an initialization file. | ||||||||||||||||
| public WinDef. | Returns: The return value is the number of characters copied to the buffer, not including the terminatingnull character.
If neither
If either
In the event the initialization file specified by
The name of the section containing the key name. If this
parameter is lpAppName, String null, the
GetPrivateProfileString function copies all section
names in the file to the supplied buffer.The name of the key whose associated string is to be
retrieved. If this parameter is lpKeyName, String null, all key names in
the section specified by the lpAppName parameter are
copied to the buffer specified by the lpReturnedString
parameter.A default string. If the lpDefault, char[] lpKeyName key cannot be found
in the initialization file, GetPrivateProfileString
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 A pointer to the buffer that receives the retrieved string. lpReturnedString, WinDef.The size of the buffer pointed to by the
nSize,lpReturnedString parameter, in characters.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. lpFileName)Retrieves a string from the specified section in an initialization file. | ||||||||||||||||
| public Pointer | Returns: address of the exported functionA handle to the DLL module that contains the function or
variable. The LoadLibrary, LoadLibraryEx,
LoadPackagedLibrary, or GetModuleHandle function returns
this handle. hmodule,ordinal value of the function export ordinal)Retrieves the address of an exported function or variable from the specified dynamic-link library (DLL). | ||||||||||||||||
| public boolean | Returns: If the function succeeds, returnstrue and the function sets
the variables pointed to by lpProcessAffinityMask and
lpSystemAffinityMask to the appropriate affinity masks.
On a system with more than 64 processors, if the threads of the
calling process are in a single processor group, the function sets
the variables pointed to by
If the function fails, the return value is A handle to the process whose affinity mask is desired.
hProcess,
This handle must have the A pointer to a variable that receives the affinity mask for the
specified process. lpProcessAffinityMask,A pointer to a variable that receives the affinity mask for the
system. lpSystemAffinityMaskRetrieves the process affinity mask for the specified process and the system affinity mask for the system. | ||||||||||||||||
| public int | Returns: If the function succeeds, the return value is the process identifier of the specified process. If the function fails, the return value is zero. To get extended error information, call GetLastError.Handle to the process. The handle must have the
PROCESS_QUERY_INFORMATION access right. processThe GetProcessId function retrieves the process identifier of the specified process. | ||||||||||||||||
| public boolean | Returns: If the function succeeds, the return value is nonzero. If the function fails, the return value is zero. To get extended error information, call GetLastError.A handle to the process. The handle must have the
PROCESS_QUERY_INFORMATION or PROCESS_QUERY_LIMITED_INFORMATION
access right. hProcess,A pointer to an IO_COUNTERS structure that receives the I/O
accounting information for the process. lpIoCountersRetrieves accounting information for all I/O operations performed by the specified process. | ||||||||||||||||
| public boolean | Returns: If the function succeeds, the return value is nonzero. If the function fails, the return value is zero. To get extended error information, call GetLastError.A handle to the process whose timing information is sought.
The handle must have the PROCESS_QUERY_INFORMATION or
PROCESS_QUERY_LIMITED_INFORMATION access right. hProcess,A pointer to a FILETIME structure that receives the creation
time of the process. lpCreationTime,A pointer to a FILETIME structure that receives the exit time
of the process. If the process has not exited, the content of
this structure is undefined. lpExitTime,A pointer to a FILETIME structure that receives the amount of
time that the process has executed in kernel mode. The time
that each of the threads of the process has executed in kernel
mode is determined, and then all of those times are summed
together to obtain this value. lpKernelTime,A pointer to a FILETIME structure that receives the amount of
time that the process has executed in user mode. The time that
each of the threads of the process has executed in user mode
is determined, and then all of those times are summed together
to obtain this value. Note that this value can exceed the
amount of real time elapsed (between lpCreationTime and
lpExitTime) if the process executes across multiple CPU cores. lpUserTimeRetrieves timing information for the specified process. | ||||||||||||||||
| public int | Returns: If the function succeeds, the return value is the version of the system on which the process expects to run. The high word of the return value contains the major version number. The low word of the return value contains the minor version number. If the function fails, the return value is zero. To get extended error information, call GetLastError. The function fails if ProcessId is an invalid value.Process identifier of the process of interest. A value of zero
specifies the calling process. processId)The GetProcessVersion function retrieves the major and minor version numbers of the system on which the specified process expects to run. | ||||||||||||||||
| public boolean | Returns: Returns nonzero (TRUE) if successful or zero (FALSE) otherwise.A handle to the completion port. CompletionPort,A pointer to a variable that receives the number of bytes
transferred during an I/O operation that has completed. lpNumberOfBytes, BaseTSD.A pointer to a variable that receives the completion key value
associated with the file handle whose I/O operation has
completed. lpCompletionKey,A pointer to a variable that receives the address of the
OVERLAPPED structure that was specified when the completed I/O
operation was started. lpOverlapped, int The number of milliseconds that the caller is willing to wait
for a completion packet to appear at the completion port. dwMilliseconds)Attempts to dequeue an I/O completion packet from the specified I/O completion port. | ||||||||||||||||
| public int | Returns: If the function succeeds, the return value is the length, in TCHARs, of the string that is copied to lpszShortPath, not including the terminating null character. If the lpszShortPath buffer is too small to contain the path, the return value is the size of the buffer, in TCHARs, that is required to hold the path and the terminating null character. If the function fails for any other reason, the return value is zero. To get extended error information, call GetLastError.The path string. lpszLongPath, char[] A pointer to a buffer to receive the null-terminated short
form of the path that lpszLongPath specifies. lpdzShortPath, int The size of the buffer that lpszShortPath points to, in
TCHARs. cchBuffer)Retrieves the short path form of the specified path. | ||||||||||||||||
| public WinDef. | Returns: Returns the locale identifier for the system default locale, identified by LOCALE_SYSTEM_DEFAULT.Returns the locale identifier for the system locale. | ||||||||||||||||
| public void | GetSystemInfo(WinBase.
Pointer to a SYSTEM_INFO structure that receives the
information. lpSystemInfoThe GetSystemInfo function returns information about the current system. | ||||||||||||||||
| public void | GetSystemTime(WinBase.
Pointer to a lpSystemTimeWinBase. structure to receive the current
system date and time.The GetSystemTime function retrieves the current system date and time. | ||||||||||||||||
| public boolean | Returns: true if the function succeeds, false otherwise.
If the function fails, call GetLastError() to get extended error
information.A pointer to a lpIdleTime,WinBase. structure that
receives the amount of time that the system has been idle.A pointer to a lpKernelTime,WinBase. structure that
receives the amount of time that the system has spent
executing in Kernel mode (including all threads in all
processes, on all processors). This time value also includes
the amount of time the system has been idle.A pointer to a lpUserTimeWinBase. structure that
receives the amount of time that the system has spent
executing in User mode (including all threads in all
processes, on all processors).Retrieves system timing information. | ||||||||||||||||
| public WinDef. | Returns: If the function succeeds, the return value is the length, in TCHARs, of the string copied to lpBuffer, not including the terminating null character. If the return value is greater than nBufferLength, the return value is the length, in TCHARs, of the buffer required to hold the path. If the function fails, the return value is zero. To get extended error information, call GetLastError.Size of the string buffer identified by lpBuffer, in TCHARs. nBufferLength,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\. buffer)The GetTempPath function retrieves the path of the directory designated for temporary files. | ||||||||||||||||
| public int | Returns: If the function succeeds, the return value is the priority class of the specified thread.If the function fails, the return value is THREAD_PRIORITY_ERROR_RETURN. A handle to the process. hProcessGets the priority value of the specified thread. | ||||||||||||||||
| public int | Returns: Number of milliseconds that have elapsed since the system was started.The GetTickCount function retrieves the number of milliseconds that have elapsed since the system was started, up to 49.7 days. | ||||||||||||||||
| public long | Returns: Number of milliseconds that have elapsed since the system was started.The GetTickCount64 function retrieves the number of milliseconds that have elapsed since the system was started. | ||||||||||||||||
| public WinDef. | Returns: Returns the locale identifier for the user default locale, represented as LOCALE_USER_DEFAULT. If the user default locale is a custom locale, this function always returns LOCALE_CUSTOM_DEFAULT, regardless of the custom locale that is selected. For example, whether the user locale is Hawaiian (US), haw-US, or Fijiian (Fiji), fj-FJ, the function returns the same value.Returns the locale identifier for the user default locale. | ||||||||||||||||
| public WinDef. | Returns: If the function succeeds, the return value includes the major and minor version numbers of the operating system in the low order word, and information about the operating system platform in the high order word.The GetVersion function returns the current version number of the operating system. | ||||||||||||||||
| public boolean | Returns: If the function succeeds, the return value is a nonzero value. If the function fails, the return value is zero. To get extended error information, call GetLastError. The function fails if you specify an invalid value for the dwOSVersionInfoSize member of the OSVERSIONINFO or OSVERSIONINFOEX structure.Pointer to an OSVERSIONINFO data structure that the function
fills with operating system version information. lpVersionInfoThe GetVersionEx function obtains extended information about the version of the operating system that is currently running. | ||||||||||||||||
| public boolean | Returns: If the function succeeds, the return value is a nonzero value. If the function fails, the return value is zero. To get extended error information, call GetLastError. The function fails if you specify an invalid value for the dwOSVersionInfoSize member of the OSVERSIONINFO or OSVERSIONINFOEX structure.Pointer to an OSVERSIONINFOEX data structure that the function
fills with operating system version information. lpVersionInfoThe GetVersionEx function obtains extended information about the version of the operating system that is currently running. | ||||||||||||||||
| public boolean | GetVolumeInformation(String
A string that contains the root directory of the
volume to be described. If this parameter is lpRootPathName, char[] null, the root of
the current directory is used. A trailing backslash is required. For example,
you specify "\\MyServer\MyShare\", or "C:\".If not lpVolumeNameBuffer, int null then receives the name of
the specified volume. The buffer size is specified by the nVolumeNameSize
parameter.The length of the volume name buffer - max. size is
nVolumeNameSize, IntByReference WinDef#MAX_PATH + 1 - ignored if no volume name buffer providedReceives the volume serial number - can be
lpVolumeSerialNumber, IntByReference null if the serial number is not requiredReceives the maximum length of a file name
component that the underlying file system supports - can be lpMaximumComponentLength, IntByReference null
if this data is not requiredReceives flags associated with the file system
- can be lpFileSystemFlags, char[] null if this data is not requiredIf not lpFileSystemNameBuffer, int null then receives the name
of the file system. The buffer size is specified by the nFileSystemNameSize
parameter.The length of the file system name buffer -
max. size is nFileSystemNameSize)WinDef#MAX_PATH + 1 - ignored if no file system name
buffer provided
| ||||||||||||||||
| public boolean | GetVolumeNameForVolumeMountPoint(String
A string that contains the path of a mounted
folder (e.g., "Y:\MountX\") or a drive letter (for example,
"X:\"). The string must end with a trailing backslash. lpszVolumeMountPoint, char[] A buffer that receives the volume GUID path - if
there is more than one volume GUID path for the volume, only the first
one in the mount manager's cache is returned. lpszVolumeName, int The length of the output buffer - a reasonable size
for the buffer to accommodate the largest possible volume GUID path is
at 50 characters cchBufferLength)Retrieves a volume GUID path for the volume that is associated with the specified volume mount point (drive letter, volume GUID path, or mounted folder). | ||||||||||||||||
| public boolean | GetVolumePathName(String
The input path string. Both absolute and relative
file and directory names, for example "..", are acceptable in
this path. If you specify a relative directory or file name without a
volume qualifier, returns the drive letter of the boot volume. If this
parameter is an empty string, the function fails but the last error is
set to lpszFileName, char[] ERROR_SUCCESS.Buffer receives the volume mount point for the
input path. lpszVolumePathName, int The length of the output buffer cchBufferLength)Retrieves the volume mount point where the specified path is mounted. | ||||||||||||||||
| public boolean | Returns: true if succeeds. If fails then call GetLastError()
to get extended error information. If the buffer is not large enough to hold
the complete list, the error code is ERROR_MORE_DATA and the
lpcchReturnLength parameter receives the required buffer size.A volume GUID path for the volume lpszVolumeName, char[] A buffer that receives the list of drive
letters and mounted folder paths. The list is an array of null-terminated
strings terminated by an additional NULL character. If the buffer is
not large enough to hold the complete list, the buffer holds as much of
the list as possible. lpszVolumePathNames, int The available length of the buffer - including all
NULL characters. cchBufferLength, IntByReference If the call is successful, this parameter is the
number of character copied to the buffer. Otherwise, this parameter is the
size of the buffer required to hold the complete list lpcchReturnLength)Retrieves a list of drive letters and mounted folder paths for the specified volume | ||||||||||||||||
| public Pointer | Returns: If the function succeeds, the return value is NULL If the function fails, the return value is equal to a handle to the global memory object. To get extended error information, callGetLastError.A handle to the global memory object. hGlobal)Frees the specified global memory object and invalidates its handle. | ||||||||||||||||
| public boolean | Returns: If the function succeeds, the return value is nonzero. If the function fails, the return value is zero. To get extended error information, call GetLastError.A pointer to a MEMORYSTATUSEX structure that receives
information about current memory availability. lpBufferRetrieves information about the system's current usage of both physical and virtual memory. | ||||||||||||||||
| public boolean | Returns: If the function succeeds, the return value is a nonzero value. If the function fails, the return value is zero. To get extended error information, call GetLastError.Handle to a process. hProcess,Pointer to a value that is set to TRUE if the process is
running under WOW64. Otherwise, the value is set to FALSE. Wow64Process)The IsWow64Process function determines whether the specified process is running under WOW64. | ||||||||||||||||
| public WinDef. | Returns: If the function succeeds, the return value is a handle to the loaded module.If the function fails, the return value is NULL. To get extended error information, call GetLastError. A string that specifies the file name of the module to load.
This name is not related to the name stored in a library
module itself, as specified by the LIBRARY keyword in the
module-definition (.def) file. lpFileName, WinNT.The module can be a library module (a .dll file) or an executable module (an .exe file). If the specified module is an executable module, static imports are not loaded; instead, the module is loaded as if DONT_RESOLVE_DLL_REFERENCES was specified. See the dwFlags parameter for more information. 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. If the string specifies a fully qualified path, the function searches only that path for the module. When specifying a path, be sure to use backslashes (\), not forward slashes (/). For more information about paths, see "Naming Files, Paths, and Namespaces" on MSDN. If the string specifies a module name without a path and more than one loaded module has the same base name and extension, the function returns a handle to the module that was loaded first. If the string specifies a module name without a path and a module of the same name is not already loaded, or if the string specifies a module name with a relative path, the function searches for the specified module. The function also searches for modules if loading the specified module causes the system to load other associated modules (that is, if the module has dependencies). The directories that are searched and the order in which they are searched depend on the specified path and the dwFlags parameter. For more information, see Remarks. If the function cannot find the module or one of its dependencies, the function fails. This parameter is reserved for future use. It must be NULL. hFile,The action to be taken when loading the module. flags)If no flags are specified, the behavior of this function is identical to that of the LoadLibrary function. This parameter can be one of the following values. DONT_RESOLVE_DLL_REFERENCES: 0x00000001 If this value is used, and the executable module is a DLL, the system does not call DllMain for process and thread initialization and termination. Also, the system does not load additional executable modules that are referenced by the specified module. Do not use this value; it is provided only for backward compatibility. If you are planning to access only data or resources in the DLL, use LOAD_LIBRARY_AS_DATAFILE_EXCLUSIVE or LOAD_LIBRARY_AS_IMAGE_RESOURCE or both. Otherwise, load the library as a DLL or executable module using the LoadLibrary function. LOAD_IGNORE_CODE_AUTHZ_LEVEL: 0x00000010 If this value is used, the system does not check AppLocker rules or apply Software Restriction Policies for the DLL. AppLocker was introduced in Windows 7 and Windows Server 2008 R2. This action applies only to the DLL being loaded and not to its dependencies. This value is recommended for use in setup programs that must run extracted DLLs during installation. Windows Server 2008 R2 and Windows 7: On systems with KB2532445 installed, the caller must be running as "LocalSystem" or "TrustedInstaller"; otherwise the system ignores this flag. LOAD_LIBRARY_AS_DATAFILE: 0x00000002 If this value is used, the system maps the file into the calling process's virtual address space as if it were a data file. Nothing is done to execute or prepare to execute the mapped file. Therefore, you cannot call functions like GetModuleFileName, GetModuleHandle or GetProcAddress with this DLL. Using this value causes writes to read-only memory to raise an access violation. Use this flag when you want to load a DLL only to extract messages or resources from it. This value can be used with LOAD_LIBRARY_AS_IMAGE_RESOURCE. For more information, see Remarks LOAD_LIBRARY_AS_DATAFILE_EXCLUSIVE: 0x00000040 Similar to LOAD_LIBRARY_AS_DATAFILE, except that the DLL file is opened with exclusive write access for the calling process. Other processes cannot open the DLL file for write access while it is in use. However, the DLL can still be opened by other processes. This value can be used with LOAD_LIBRARY_AS_IMAGE_RESOURCE. This value is not supported until Windows Vista. LOAD_LIBRARY_AS_IMAGE_RESOURCE: 0x00000020 If this value is used, the system maps the file into the process's virtual address space as an image file. However, the loader does not load the static imports or perform the other usual initialization steps. Use this flag when you want to load a DLL only to extract messages or resources from it. Unless the application depends on the file having the in-memory layout of an image, this value should be used with either LOAD_LIBRARY_AS_DATAFILE_EXCLUSIVE or LOAD_LIBRARY_AS_DATAFILE. This value is not supported until Windows Vista. LOAD_LIBRARY_SEARCH_APPLICATION_DIR: 0x00000200 If this value is used, the application's installation directory is searched for the DLL and its dependencies. Directories in the standard search path are not searched. This value cannot be combined with LOAD_WITH_ALTERED_SEARCH_PATH. Windows 7, Windows Server 2008 R2, Windows Vista, and Windows Server 2008: This value requires KB2533623 to be installed. LOAD_LIBRARY_SEARCH_DEFAULT_DIRS: 0x00001000 This value is a combination of LOAD_LIBRARY_SEARCH_APPLICATION_DIR, LOAD_LIBRARY_SEARCH_SYSTEM32, and LOAD_LIBRARY_SEARCH_USER_DIRS. Directories in the standard search path are not searched. This value cannot be combined with LOAD_WITH_ALTERED_SEARCH_PATH. This value represents the recommended maximum number of directories an application should include in its DLL search path. Windows 7, Windows Server 2008 R2, Windows Vista, and Windows Server 2008: This value requires KB2533623 to be installed. LOAD_LIBRARY_SEARCH_DLL_LOAD_DIR: 0x00000100 If this value is used, the directory that contains the DLL is temporarily added to the beginning of the list of directories that are searched for the DLL's dependencies. Directories in the standard search path are not searched. The lpFileName parameter must specify a fully qualified path. This value cannot be combined with LOAD_WITH_ALTERED_SEARCH_PATH. For example, if Lib2.dll is a dependency of C:\Dir1\Lib1.dll, loading Lib1.dll with this value causes the system to search for Lib2.dll only in C:\Dir1. To search for Lib2.dll in C:\Dir1 and all of the directories in the DLL search path, combine this value with LOAD_LIBRARY_DEFAULT_DIRS. Windows 7, Windows Server 2008 R2, Windows Vista, and Windows Server 2008: This value requires KB2533623 to be installed. LOAD_LIBRARY_SEARCH_SYSTEM32: 0x00000800 If this value is used, %windows%\system32 is searched for the DLL and its dependencies. Directories in the standard search path are not searched. This value cannot be combined with LOAD_WITH_ALTERED_SEARCH_PATH. Windows 7, Windows Server 2008 R2, Windows Vista, and Windows Server 2008: This value requires KB2533623 to be installed. LOAD_LIBRARY_SEARCH_USER_DIRS: 0x00000400 If this value is used, directories added using the AddDllDirectory or the SetDllDirectory function are searched for the DLL and its dependencies. If more than one directory has been added, the order in which the directories are searched is unspecified. Directories in the standard search path are not searched. This value cannot be combined with LOAD_WITH_ALTERED_SEARCH_PATH. Windows 7, Windows Server 2008 R2, Windows Vista, and Windows Server 2008: This value requires KB2533623 to be installed. LOAD_WITH_ALTERED_SEARCH_PATH: 0x00000008 If this value is used and lpFileName specifies an absolute path, the system uses the alternate file search strategy discussed in the Remarks section to find associated executable modules that the specified module causes to be loaded. If this value is used and lpFileName specifies a relative path, the behavior is undefined. If this value is not used, or if lpFileName does not specify a path, the system uses the standard search strategy discussed in the Remarks section to find associated executable modules that the specified module causes to be loaded. This value cannot be combined with any LOAD_LIBRARY_SEARCH flag. Loads the specified module into the address space of the calling process. | ||||||||||||||||
| public WinNT. | Returns: If the function succeeds, the return value is a handle to the data associated with the resource.If the function fails, the return value is NULL. To get extended error information, call GetLastError. A handle to the module whose executable file contains the
resource. hModule,If hModule is NULL, the system loads the resource from the module that was used to create the current process. A handle to the resource to be loaded. hResourceThis handle is returned by the FindResource or FindResourceEx function. Retrieves a handle that can be used to obtain a pointer to the first byte of the specified resource in memory. | ||||||||||||||||
| public Pointer | Returns: If the function succeeds, the return value is a handle to the newly allocated memory object. If the function fails, the return value is NULL. To get extended error information, call GetLastError.Memory allocation attributes. The default is the LMEM_FIXED
value. uFlags, int 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. uBytes)The LocalAlloc function allocates the specified number of bytes from the heap. | ||||||||||||||||
| public Pointer | 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, callGetLastError.A handle to the local memory object. If the hMem parameter
is NULL, hMem)LocalFree ignores the parameter and returns NULL.Frees the specified local memory object and invalidates its handle. | ||||||||||||||||
| public Pointer | Returns: If the loaded resource is available, the return value is a pointer to the first byte of the resource; otherwise, it is NULL.A handle to the resource to be accessed. hResourceThe LoadResource function returns this handle. Note that this parameter is listed as an HGLOBAL variable only for backward compatibility. Do not pass any value as a parameter other than a successful return value from the LoadResource function. Retrieves a pointer to the specified resource in memory. | ||||||||||||||||
| public Pointer | Returns: If the function succeeds, the return value is the starting address of the mapped view. If the function fails, the return value is NULL. To get extended error information, call GetLastError.A handle to a file mapping object. The CreateFileMapping and
OpenFileMapping functions return this handle. hFileMappingObject,The type of access to a file mapping object, which determines
the protection of the pages. dwDesiredAccess, int A high-order DWORD of the file offset where the view begins. dwFileOffsetHigh, int A low-order DWORD of the file offset where the view is to
begin. dwFileOffsetLow, int The number of bytes of a file mapping to map to the view. dwNumberOfBytesToMap)Maps a view of a file mapping into the address space of a calling process. | ||||||||||||||||
| public boolean | Returns: Returns TRUE if the first entry of the module list has been copied to the buffer or FALSE otherwise.The ERROR_NO_MORE_FILES error value is returned by the GetLastError function if no modules exist or the snapshot does not contain module information. A handle to the snapshot returned from a previous call to the
CreateToolhelp32Snapshot function. hSnapshot,A pointer to a MODULEENTRY32 structure. lpmeRetrieves information about the first module associated with a process. | ||||||||||||||||
| public boolean | Returns: Returns TRUE if the first entry of the module list has been copied to the buffer or FALSE otherwise.The ERROR_NO_MORE_FILES error value is returned by the GetLastError function if no modules exist or the snapshot does not contain module information. A handle to the snapshot returned from a previous call to the
CreateToolhelp32Snapshot function. hSnapshot,A pointer to a MODULEENTRY32 structure. lpmeRetrieves information about the next module associated with a process or thread. | ||||||||||||||||
| public boolean | Returns: true, if successful If the function succeeds, the return value is nonzero. If the function fails, the return value is zero. To get extended error information, call GetLastError.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. lpExistingFileName, String 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. lpNewFileName)Moves an existing file or a directory, including its children. | ||||||||||||||||
| public boolean | Returns: true, if successful If the function succeeds, the return value is nonzero. If the function fails, the return value is zero. To get extended error information, call GetLastError.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. lpExistingFileName, String 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. lpNewFileName, WinDef.This parameter can be one or more of the following values. dwFlagsMoves an existing file or directory, including its children, with various move options. | ||||||||||||||||
| public WinNT. | Returns: If the function succeeds, the return value is a handle to the event object.
If the function fails, the return value is The access to the event object. The function fails
if the security descriptor of the specified object
does not permit the requested access for the
calling process. For a list of access rights, see
Synchronization Object Security and Access Rights. dwDesiredAccess, boolean If this value is TRUE, processes created by this
process will inherit the handle. Otherwise, the
processes do not inherit this handle. bInheritHandle, String The name of the event to be opened. Name
comparisons are case sensitive.
lpName)This function can open objects in a private namespace. For more information, see Object Namespaces. Terminal Services: The name can have a "Global" or "Local" prefix to explicitly open an object in the global or session namespace. The remainder of the name can contain any character except the backslash character (). For more information, see Kernel Object Namespaces. Note Fast user switching is implemented using Terminal Services sessions. The first user to log on uses session 0, the next user to log on uses session 1, and so on. Kernel object names must follow the guidelines outlined for Terminal Services so that applications can support multiple users. Opens an existing named event object. | ||||||||||||||||
| public WinNT. | Returns: If the function succeeds, the return value is an open handle to the specified file mapping object. If the function fails, the return value is NULL. To get extended error information, call GetLastError.The access to the file mapping object. This access is checked
against any security descriptor on the target file mapping object.
For a list of values, see File Mapping Security and Access Rights. dwDesiredAccess, boolean If this parameter is true, a process created by the CreateProcess
function can inherit the handle; otherwise,
the handle cannot be inherited. bInheritHandle, String The name of the file mapping object to be opened. lpName)Opens a named file mapping object. | ||||||||||||||||
| public WinNT. | Returns: If the function succeeds, the return value is a handle to the mutex object.If the function fails, the return value is NULL. To get extended error
information, call If a named mutex does not exist, the function fails and
The access to the mutex object. Only the dwDesiredAccess, boolean WinNT#SYNCHRONIZE access
right is required to use a mutex; to change the mutex's security, specify
WinBase#MUTEX_ALL_ACCESS.If this value is TRUE, processes created by this process will inherit the
handle. Otherwise, the processes do not inherit this handle. bInheritHandle, String The name of the mutex to be opened. Name comparisons are case sensitive.
lpName)This function can open objects in a private namespace. Terminal Services: The name can have a "Global\" or "Local\" prefix to explicitly open an object in the global or session namespace. The remainder of the name can contain any character except the backslash character (\). Opens an existing named mutex object. | ||||||||||||||||
| public WinNT. | Returns: An open handle to the specified process indicates success. NULL indicates failure. To get extended error information, call GetLastError.The access to the process object. This access right is
checked against the security descriptor for the process. This parameter
can be one or more of the process access rights.
fdwAccess, boolean If the caller has enabled the SeDebugPrivilege privilege, the requested access is granted regardless of the contents of the security descriptor. If this value is TRUE, processes created by this process will inherit the handle. Otherwise, the processes do not inherit this handle. fInherit, int Specifies the process identifier of the process to open. IDProcess)This function returns a handle to an existing process object. | ||||||||||||||||
| public WinNT. | Returns: If the function succeeds, the return value is an open handle to the specified process. If the function fails, the return value is NULL. To get extended error information, call GetLastError.Access to the thread object. This access right is checked
against any security descriptor for the thread. dwDesiredAccess, boolean If this parameter is TRUE, the new process inherits the
handle. If the parameter is FALSE, the handle is not
inherited. bInheritHandle, int Identifier of the thread to be opened. dwThreadId)The OpenThread function opens an existing thread object. | ||||||||||||||||
| public boolean | Returns: true if successful, false otherwise.
To get extended error information, call GetLastError().A handle to the pipe. hNamedPipe,A buffer that receives data read from the pipe.
This parameter can be lpBuffer, int null if no data is to be read.The size of the buffer specified by the
lpBuffer parameter, in bytes. This parameter is ignored if
lpBuffer is nBufferSize, IntByReference null.A variable that receives the number of bytes read
from the pipe. This parameter can be lpBytesRead, IntByReference null if no data is to be read.A variable that receives the total number of
bytes available to be read from the pipe. This parameter can be lpTotalBytesAvail, IntByReference null
if no data is to be read.A variable that receives the number of
bytes remaining in this message. This parameter can be lpBytesLeftThisMessage)null
if no data is to be read.Copies data from a named or anonymous pipe into a buffer without removing it from the pipe. | ||||||||||||||||
| public boolean | Returns: If the function succeeds, the return value is nonzero. If the function fails, the return value is zero. To get extended error information, call GetLastError .A handle to an I/O completion port to which the I/O completion
packet is to be posted. CompletionPort,The value to be returned through the
lpNumberOfBytesTransferred parameter of the
GetQueuedCompletionStatus function. dwNumberOfBytesTransferred, Pointer The value to be returned through the lpCompletionKey parameter
of the GetQueuedCompletionStatus function. dwCompletionKey, WinBase.The value to be returned through the lpOverlapped parameter of
the GetQueuedCompletionStatus function. lpOverlappedPosts an I/O completion packet to an I/O completion port. | ||||||||||||||||
| public boolean | Returns: Returns TRUE if the first entry of the process list has been copied to the buffer or FALSE otherwise. The ERROR_NO_MORE_FILES error value is returned by the GetLastError function if no processes exist or the snapshot does not contain process information.A handle to the snapshot returned from a previous call to the
CreateToolhelp32Snapshot function. hSnapshot,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. lppeRetrieves information about the first process encountered in a system snapshot. | ||||||||||||||||
| public boolean | Returns: Returns TRUE if the next entry of the process list has been copied to the buffer or FALSE otherwise. The ERROR_NO_MORE_FILES error value is returned by the GetLastError function if no processes exist or the snapshot does not contain process information.A handle to the snapshot returned from a previous call to the
CreateToolhelp32Snapshot function. hSnapshot,A pointer to a PROCESSENTRY32 structure. lppeRetrieves information about the next process recorded in a system snapshot. | ||||||||||||||||
| public boolean | Returns: If the function succeeds, the return value is true.If the function fails, the return value is false. To get extended error information, call GetLastError. Specifies a process identifier. dwProcessId, IntByReference Use the GetCurrentProcessId function to retrieve the process identifier for the current process. Pointer to a variable that receives the identifier of the
Remote Desktop Services session under which the specified
process is running. pSessionId)To retrieve the identifier of the session currently attached to the console, use the WTSGetActiveConsoleSessionId function. http://msdn.microsoft.com/en-us/library/aa382990(v=vs.85).aspx Retrieves the Remote Desktop Services session associated with a specified process. | ||||||||||||||||
| public boolean | Returns: If the function succeeds, the return value is nonzero. If the function fails, the return value is zero. To get extended error information, call GetLastError.A handle to the event object. The CreateEvent or OpenEvent
function returns this handle. hEventSets the specified event object to the signaled state and then resets it to the nonsignaled state after releasing the appropriate number of waiting threads. | ||||||||||||||||
| public int | Returns: If the function succeeds, the return value is the number of characters stored into the buffer, otherwise zero. UseGetLastError() to get extended
error information. If the buffer is too small, the function fails and the last error
code is ERROR_INSUFFICIENT_BUFFER.An MS-DOS device name string specifying the target
of the query. The device name cannot have a trailing backslash; for
example, use "C:", not "C:\". This parameter can be
NULL. In that case, the function will store a list of all existing MS-DOS
device names into the buffer. lpDeviceName, char[] A buffer that will receive the result of the query.
The function fills this buffer with one or more null-terminated strings.
The final null-terminated string is followed by an additional NULL. If
device name is non-NULL, the function retrieves information about the
particular MS-DOS device. The first null-terminated string stored into
the buffer is the current mapping for the device. The other null-terminated
strings represent undeleted prior mappings for the device. Each
null-terminated string stored into the buffer is the name of an existing
MS-DOS device, for example, lpTargetPath, int \Device\HarddiskVolume1 or \Device\Floppy0.The maximum number of characters that can be stored into the buffer ucchMax)Retrieves information about MS-DOS device names | ||||||||||||||||
| public boolean | Returns: true if successful false if not. To get extended error information, call GetLastError.Handle for the running process hProcess,0 - The name should use the Win32 path format.
1(WinNT.PROCESS_NAME_NATIVE) - The name should use the native system path format. dwFlags, char[] pre-allocated character buffer for the returned path lpExeName, IntByReference input: the size of the allocated buffer
output: the length of the returned path in characters lpdwSize)This function retrieves the full path of the executable file of a given process. | ||||||||||||||||
| public boolean | Returns: If the function succeeds, the return value is nonzero. For synchronous calls, this means that the operation succeeded. For asynchronous calls, this indicates that the operation was successfully queued. If the function fails, the return value is zero. To get extended error information, call GetLastError. If the network redirector or the target file system does not support this operation, the function fails with ERROR_INVALID_FUNCTION.A handle to the directory to be monitored. This directory must
be opened with the FILE_LIST_DIRECTORY access right. directory,A pointer to the DWORD-aligned formatted buffer in which the
read results are to be returned. info,The size of the buffer that is pointed to by the lpBuffer
parameter, in bytes. length, boolean 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. watchSubtree, int The filter criteria that the function checks to determine if
the wait operation has completed. notifyFilter, IntByReference 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. bytesReturned, WinBase.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. overlapped,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. completionRoutineRetrieves information that describes the changes within the specified directory. | ||||||||||||||||
| public boolean | Returns: If the function succeeds, the return value is nonzero (TRUE). If the function fails, or is completing asynchronously, the return value is zero (FALSE). To get extended error information, call the GetLastError function. Note The GetLastError code ERROR_IO_PENDING is not a failure; it designates the read operation is pending completion asynchronously. For more information, see Remarks.A handle to the device (for example, a file, file stream,
physical disk, volume, console buffer, tape drive, socket,
communications resource, mailslot, or pipe). hFile,A pointer to the buffer that receives the data read from a
file or device. lpBuffer, int The maximum number of bytes to be read. nNumberOfBytesToRead, IntByReference A pointer to the variable that receives the number of bytes
read when using a synchronous hFile parameter lpNumberOfBytesRead, WinBase.A pointer to an OVERLAPPED structure is required if the hFile
parameter was opened with FILE_FLAG_OVERLAPPED, otherwise it
can be NULL. lpOverlappedReads data from the specified file or input/output (I/O) device. | ||||||||||||||||
| public boolean | Returns: If the function succeeds, the return value is nonzero.If the function fails, the return value is 0 (zero). To get extended error information, call GetLastError. The function fails if the requested read operation crosses into an area of the process that is inaccessible. A handle to the process with memory that is being read. The
handle must have PROCESS_VM_READ access to the process. hProcess,A pointer to the base address in the specified process from
which to read. lpBaseAddress, Pointer Before any data transfer occurs, the system verifies that all data in the base address and memory of the specified size is accessible for read access, and if it is not accessible the function fails. A pointer to a buffer that receives the contents from the
address space of the specified process. lpBuffer, int The number of bytes to be read from the specified process. nSize, IntByReference A pointer to a variable that receives the number of bytes
transferred into the specified buffer. If lpNumberOfBytesRead
is NULL, the parameter is ignored. lpNumberOfBytesRead)Reads data from an area of memory in a specified process. | ||||||||||||||||
| public WinNT. | Returns: This function returns S_OK on success or one of the following error codes.
A pointer to a Unicode string that specifies the
command-line arguments for the application when it
is restarted. The maximum size of the command line
that you can specify is RESTART_MAX_CMD_LINE
characters. Do not include the name of the
executable in the command line; this function adds
it for you.
pwzCommandline, int If this parameter is NULL or an empty string, the previously registered command line is removed. If the argument contains spaces, use quotes around the argument. This parameter can be 0 or one or more of the
following values.
dwFlags)
Registers the active instance of an application for restart. | ||||||||||||||||
| public boolean | Returns: If the function succeeds, the return value is nonzero.If the function fails, the return value is zero. To get extended error
information, call A handle to the mutex object. The CreateMutex or OpenMutex function
returns this handle. handleReleases ownership of the specified mutex object. | ||||||||||||||||
| public boolean | Returns: If the function succeeds, the return value is nonzero. If the function fails the return value is zero. To get extended error information, call GetLastError.A handle to the event object hEventResets (to non-signaled state) the specified event object. | ||||||||||||||||
| public boolean | Returns: If the function succeeds, the return value is nonzero. If the function fails, the return value is zero. To get extended error information, callKernel32#GetLastError().[in] A handle to the communications device. The
hFile,com.
function returns this handle.[in] A pointer to a lpDCBWinBase. structure that
contains the configuration information for the specified
communications device.Configures a communications device according to the specifications in a
device-control block (a | ||||||||||||||||
| public boolean | Returns: If the function succeeds, the return value is nonzero.If the function fails, the return value is zero. To get extended error information, call Kernel32#GetLastError().[in] A handle to the communications device. The
hFile,com.
function returns this handle.[in] A pointer to a lpCommTimeoutsWinBase. structure
that contains the new time-out values.Sets the time-out parameters for all read and write operations on a specified communications device. | ||||||||||||||||
| public boolean | Returns: If the function succeeds, the return value is non-zero. If the function fails, the return value is zero. To get extended error information, call GetLastError.Pointer to a string containing the name of the environment
variable to set. lpName, String 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. lpValue)The SetEnvironmentVariable function sets the contents of the specified environment variable for the current process. | ||||||||||||||||
| public int | Returns: The return value is the previous state of the error-mode bit flags.The process error mode. umode)Controls whether the system will handle the specified types of serious errors or whether the process will handle them. | ||||||||||||||||
| public boolean | Returns: If the function succeeds, the return value is nonzero. If the function fails, the return value is zero. To get extended error information, call GetLastError.A handle to the event object. The CreateEvent or OpenEvent
function returns this handle. hEventSets the specified event object to the signaled state. | ||||||||||||||||
| public boolean | Returns: If the function succeeds, the return value is nonzero. If the function fails, the return value is zero. To get extended error information, call GetLastError.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. lpFileName, WinDef.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. dwFileAttributesSets the attributes for a file or directory. | ||||||||||||||||
| public boolean | Returns: Returns nonzero if successful or zero otherwise. To get extended error information, call GetLastError.A handle to the file for which to change information.
This handle must be opened with the appropriate permissions for the
requested change. This handle should not be a pipe handle. hFile,A FILE_INFO_BY_HANDLE_CLASS enumeration value that specifies the type of information to be changed.
Valid values are FILE_BASIC_INFO, FILE_RENAME_INFO, FILE_DISPOSITION_INFO, FILE_ALLOCATION_INFO,
FILE_END_OF_FILE_INFO, and FILE_IO_PRIORITY_HINT_INFO FileInformationClass, Pointer A pointer to the buffer that contains the information to change for the specified file
information class. The structure that this parameter points to corresponds to the class
that is specified by FileInformationClass. lpFileInformation, WinDef.The size of the lpFileInformation buffer, in bytes. dwBufferSizeSets the file information for the specified file. | ||||||||||||||||
| public int | Returns: If the function succeeds, the return value is nonzero. If the function fails, the return value is zero. To get extended error information, call GetLastError.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. hFile,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. lpCreationTime,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. lpLastAccessTime,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. lpLastWriteTimeSets the date and time that the specified file or directory was created, last accessed, or last modified. | ||||||||||||||||
| public boolean | Returns: If the function succeeds, the return value is nonzero. If the function fails, the return value is zero. To get extended error information, call GetLastError.A handle to an object whose information is to be set. hObject,A mask that specifies the bit flags to be changed. Use the
same constants shown in the description of dwFlags. dwMask, int Set of bit flags that specifies properties of the object
handle. dwFlags)Sets certain properties of an object handle. | ||||||||||||||||
| public void | SetLastError(int
Last-error code for the thread. dwErrCode)The SetLastError function sets the last-error code for the calling thread. | ||||||||||||||||
| public boolean | Returns: true if the function succeeds, false otherwise.
If the function fails, call GetLastError() to get extended error
information.Pointer to a lpSystemTimeWinBase. structure holding the new
system date and timeNote The Sets the current local time and date | ||||||||||||||||
| public boolean | Returns: true if successful, false otherwise.
To get extended error information, call GetLastError().A handle to the named pipe instance. hNamedPipe,The new pipe mode. The mode is a combination of a read-mode
flag and a wait-mode flag. This parameter can be lpMode, IntByReference null if the
mode is not being set.The maximum number of bytes collected on
the client computer before transmission to the server. This parameter
can be lpMaxCollectionCount, IntByReference null if the count is not being set.The maximum time, in milliseconds, that can
pass before a remote named pipe transfers information over the network.
This parameter can be lpCollectDataTimeout)null if the timeout is not being set.Sets the read mode and the blocking mode of the specified named pipe. | ||||||||||||||||
| public boolean | Returns: If the function succeeds, the return value is nonzero.A handle to the process. hProcess,The priority class for the process. dwPriorityClassSets the priority class for the specified process. | ||||||||||||||||
| public boolean | Returns: If the function succeeds, the return value istrue.
If the function fails, the return value is
If the process affinity mask requests a processor that is not
configured in the system, the last error code is
On a system with more than 64 processors, if the calling process
contains threads in more than one processor group, the last error
code is A handle to the process whose affinity mask is to be set. This
handle must have the hProcess,WinNT#PROCESS_SET_INFORMATION access
right.The affinity mask for the threads of the process.
dwProcessAffinityMaskOn a system with more than 64 processors, the affinity mask must specify processors in a single processor group. Sets a processor affinity mask for the threads of the specified process. | ||||||||||||||||
| public boolean | Returns: true if the function succeeds, false otherwise.
If the function fails, call GetLastError() to get extended error
information.Pointer to a lpSystemTimeWinBase. structure holding the new
system date and timeNote The The SetSystemTime function modifies the current system date and time. | ||||||||||||||||
| public int | Returns: If the function succeeds, the return value is the previous thread execution state.If the function fails, the return value is 0 The thread's execution requirements. This parameter can be
one or more of the following values (ORed together)
esFlags)Enables an application to inform the system that it is in use, thereby preventing the system from entering sleep or turning off the display while the application is running. | ||||||||||||||||
| public boolean | Returns: If the function succeeds, the return value is nonzero.A handle to the thread whose priority value is to be set. hThread,The priority value for the thread. nPriority)Sets the priority value for the specified thread. | ||||||||||||||||
| public boolean | SetVolumeLabel(String
The volume's drive letter (for example, lpRootPathName, String X:\)
or the path of a mounted folder that is associated with the volume (for
example, Y:\MountX\). The string must end with a trailing backslash.
If this parameter is NULL, the root of the current directory is used.The new label for the volume. If this parameter is NULL,
the function deletes any existing label from the specified volume and does
not assign a new label. lpVolumeName)Sets the label of a file system volume. | ||||||||||||||||
| public boolean | SetVolumeMountPoint(String
The user-mode path to be associated with the
volume. This may be a drive letter (for example, "X:\") or a
directory on another volume (for example, "Y:\MountX\"). The
string must end with a trailing backslash. lpszVolumeMountPoint, String A volume GUID path for the volume. lpszVolumeName)Associates a volume with a drive letter or a directory on another volume. | ||||||||||||||||
| public int | Returns: If the function succeeds, the return value is the number of bytes in the resource.If the function fails, the return value is zero. To get extended error information, call GetLastError. A handle to the module whose executable file contains the
resource. hModule,A handle to the resource. This handle must be created by using
the FindResource or FindResourceEx function. hResource
| ||||||||||||||||
| public boolean | Returns: If the function succeeds, the return value is nonzero. If the function fails, the return value is zero. To get extended error information, call GetLastError.[in] A pointer to a SYSTEMTIME structure that contains the
system time to be converted from UTC to file time format. lpSystemTime,[out] A pointer to a FILETIME structure to receive the
converted system time. lpFileTimeConverts a system time to file time format. | ||||||||||||||||
| public boolean | Returns: status[in, optional] A pointer to a TIME_ZONE_INFORMATION structure
that specifies the time zone of interest. If lpTimeZone is
NULL, the function uses the currently active time zone. lpTimeZone,[in] A pointer to a SYSTEMTIME structure that specifies the
UTC time to be converted. The function converts this universal
time to the specified time zone's corresponding local time. lpUniversalTime,[out] A pointer to a SYSTEMTIME structure that
receives the local time. lpLocalTimeConverts a time in Coordinated Universal Time (UTC) to a specified time zone's corresponding local time. | ||||||||||||||||
| public boolean | Returns: If the function succeeds, the return value is nonzero. If the function fails, the return value is zero. To get extended error information, call GetLastError.A handle to the process to be terminated. hProcess,The exit code to be used by the process and threads terminated
as a result of this call. uExitCode)Terminates the specified process and all of its threads. | ||||||||||||||||
| public boolean | Returns: Returns TRUE if the first entry of the thread list has been copied to the buffer or FALSE otherwise. The ERROR_NO_MORE_FILES error value is returned by the GetLastError function if no threads exist or the snapshot does not contain thread information.A handle to the snapshot returned from a previous call to the
CreateToolhelp32Snapshot function. hSnapshot,A pointer to a THREADENTRY32 structure. lpteRetrieves information about the first thread of any process encountered in a system snapshot. | ||||||||||||||||
| public boolean | Returns: Returns TRUE if the next entry of the thread list has been copied to the buffer or FALSE otherwise. The ERROR_NO_MORE_FILES error value is returned by the GetLastError function if no threads exist or the snapshot does not contain thread information.A handle to the snapshot returned from a previous call to the
CreateToolhelp32Snapshot function. hSnapshot,A pointer to a THREADENTRY32 structure. lpteRetrieves information about the next process recorded in a system snapshot. | ||||||||||||||||
| public boolean | Returns: true if successful, false otherwise.
To get extended error information, call GetLastError().A handle to the named pipe hNamedPipe,The buffer containing the data to be written to the pipe. lpInBuffer, int The size of the input buffer, in bytes. nInBufferSize, byte[] The buffer that receives the data read from the pipe. lpOutBuffer, int The size of the output buffer, in bytes. nOutBufferSize, IntByReference Variable that receives the number of bytes read from the pipe. lpBytesRead, WinBase.A pointer to an lpOverlappedWinBase. structure. Can
be null if pipe not opened with FILE_FLAG_OVERLAPPED.Combines the functions that write a message to and read a message from the specified named pipe into a single network operation. | ||||||||||||||||
| public boolean | Returns: If the function succeeds, the return value is the starting address of the mapped view. If the function fails, the return value is NULL. To get extended error information, call GetLastError.A pointer to the base address of the mapped view of a file
that is to be unmapped. lpBaseAddress)Unmaps a mapped view of a file from the calling process's address space. | ||||||||||||||||
| public WinNT. | Returns: This function returns S_OK on success or one of the following error codes.
Removes the active instance of an application from the restart list. | ||||||||||||||||
| public boolean | Returns: If the currently running operating system satisfies the specified requirements, the return value is a nonzero value.
If the current system does not satisfy the requirements, the
return value is zero and
If the function fails, the return value is zero and
A pointer to an lpVersionInformation,com. structure
containing the operating system version requirements to
compare. The dwTypeMask parameter indicates the
members of this structure that contain information to compare.
You must set the A mask that indicates the members of the
dwTypeMask, long com. structure to be tested.The type of comparison to be used for each
dwlConditionMask)lpVersionInfo member being compared. To build this
value, call the VerSetConditionMask function once for
each com. member being compared.Compares a set of operating system version requirements to the corresponding values for the currently running version of the system. | ||||||||||||||||
| public long | Returns: The function returns the condition mask value.A value to be passed as the conditionMask, int dwlConditionMask parameter
of the VerifyVersionInfoW function. The function
stores the comparison information in the bits of this
variable.
Before the first call to A mask that indicates the member of the
typeMask, byte com. structure whose comparison
operator is being set. This value corresponds to one of the
bits specified in the dwTypeMask parameter for the
VerifyVersionInfoW function.The operator to be used for the comparison. The
condition)VerifyVersionInfoW function uses this operator to
compare a specified attribute value to the corresponding value
for the currently running system.Sets the bits of a 64-bit value to indicate the comparison operator to use for a specified operating system version attribute. | ||||||||||||||||
| public Pointer | Returns: If the function succeeds, the return value is the base address of the allocated region of pages.If the function fails, the return value is NULL. To get extended error information, call GetLastError. The handle to a process. The function allocates
memory within the virtual address space of this
process.
hProcess,The handle must have the PROCESS_VM_OPERATION access right. The pointer that specifies a desired starting
address for the region of pages that you want to
allocate.
lpAddress, BaseTSD.If you are reserving memory, the function rounds this address down to the nearest multiple of the allocation granularity.
If you are committing memory that is already reserved, the function
rounds this address down to the nearest page boundary. To determine the
size of a page and the allocation granularity on the host computer, use
the
If lpAddress is If this address is within an enclave that you have not initialized by calling InitializeEnclave, VirtualAllocEx allocates a page of zeros for the enclave at that address. The page must be previously uncommitted, and will not be measured with the EEXTEND instruction of the Intel Software Guard Extensions programming model. If the address in within an enclave that you initialized, then the allocation operation fails with the ERROR_INVALID_ADDRESS error. The size of the region of memory to allocate, in
bytes.
dwSize,If lpAddress is NULL, the function rounds dwSize up to the next page boundary.
If lpAddress is not The type of memory allocation. This parameter
must contain one of the following values.
flAllocationType, int This parameter can also specify the following values as indicated. The memory protection for the region of pages to
be allocated. If the pages are being committed,
you can specify any one of the memory protection
constants. flProtect)Reserves, commits, or changes the state of a region of memory within the virtual address space of a specified process. | ||||||||||||||||
| public boolean | Returns: If the function succeeds, the return value is a nonzero value.If the function fails, the return value is 0 (zero). To get extended error information, call GetLastError. A handle to a process. The function frees memory within
the virtual address space of the process.
hProcess,The handle must have the PROCESS_VM_OPERATION access right. A pointer to the starting address of the region of
memory to be freed.
lpAddress, BaseTSD.If the dwFreeType parameter is MEM_RELEASE, lpAddress must be the base address returned by the VirtualAllocEx function when the region is reserved. The size of the region of memory to free, in bytes.
dwSize,If the dwFreeType parameter is MEM_RELEASE, dwSize must be 0 (zero). The function frees the entire region that is reserved in the initial allocation call to VirtualAllocEx. If dwFreeType is MEM_DECOMMIT, the function decommits all memory pages that contain one or more bytes in the range from the lpAddress parameter to (lpAddress+dwSize). This means, for example, that a 2-byte region of memory that straddles a page boundary causes both pages to be decommitted. If lpAddress is the base address returned by VirtualAllocEx and dwSize is 0 (zero), the function decommits the entire region that is allocated by VirtualAllocEx. After that, the entire region is in the reserved state. One of the following values:
dwFreeType)Releases, decommits, or releases and decommits a region of memory within the virtual address space of a specified process. | ||||||||||||||||
| public boolean | Returns: true if locking succeeded.
All pages in the specified region must be committed. Memory protected
with Locking pages into memory may degrade the performance of the system by reducing the available RAM and forcing the system to swap out other critical pages to the paging file. Each version of Windows has a limit on the maximum number of pages a process can lock. This limit is intentionally small to avoid severe performance degradation. Applications that need to lock larger numbers of pages must first call the SetProcessWorkingSetSize function to increase their minimum and maximum working set sizes. The maximum number of pages that a process can lock is equal to the number of pages in its minimum working set minus a small overhead. Pages that a process has locked remain in physical memory until the process unlocks them or terminates. These pages are guaranteed not to be written to the pagefile while they are locked. To unlock a region of locked pages, use the VirtualUnlock function. Locked pages are automatically unlocked when the process terminates. This function is not like the GlobalLock or LocalLock function in that it does not increment a lock count and translate a handle into a pointer. There is no lock count for virtual pages, so multiple calls to the VirtualUnlock function are never required to unlock a region of pages. A pointer to the base address of the region of pages to
be locked. lpAddress, BaseTSD.The size of the region to be locked, in bytes. The
region of affected pages includes all pages that contain
one or more bytes in the range from the lpAddress
parameter to (lpAddress+dwSize). This means that a
2-byte range straddling a page boundary causes both
pages to be locked. dwSizeLocks the specified region of the process's virtual address space into physical memory, ensuring that subsequent access to the region will not incur a page fault. | ||||||||||||||||
| public BaseTSD. | Returns: The return value is the actual number of bytes returned in the information buffer. If the function fails, the return value is zero. To get extended error information, callGetLastError().A handle to the process whose memory information is queried. hProcess,The base address of the region of pages to be queried. lpAddress, WinNT.A lpBuffer,WinNT. structure in which
information about the specified page range is returned.The size of the buffer pointed to by the lpBuffer
parameter, in bytes. dwLengthRetrieves information about a range of pages within the virtual address space of a specified process. | ||||||||||||||||
| public boolean | Returns: true if unlocking succeeded.
For the function to succeed, the range specified need not match a range passed to a previous call to the VirtualLock function, but all pages in the range must be locked. If any of the pages in the specified range are not locked, VirtualUnlock removes such pages from the working set, sets last error to ERROR_NOT_LOCKED, and returns FALSE. Calling VirtualUnlock on a range of memory that is not locked releases the pages from the process's working set. A pointer to the base address of the region of pages to
be unlocked. lpAddress, BaseTSD.The size of the region being unlocked, in bytes. The
region of affected pages includes all pages containing
one or more bytes in the range from the lpAddress
parameter to (lpAddress+dwSize). This means that a
2-byte range straddling a page boundary causes both
pages to be unlocked. dwSizeUnlocks a specified range of pages in the virtual address space of a process, enabling the system to swap the pages out to the paging file if necessary. | ||||||||||||||||
| public int | Returns: If the function succeeds, the return value indicates the event that caused the function to return.The number of object handles in the array pointed to by
lpHandles. The maximum number of object handles is
MAXIMUM_WAIT_OBJECTS. nCount, WinNT.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. hHandle,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. bWaitAll, int 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. dwMilliseconds)Waits until one or all of the specified objects are in the signaled state or the time-out interval elapses. | ||||||||||||||||
| public int | Returns: If the function succeeds, the return value indicates the event that caused the function to return.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. hHandle,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. dwMilliseconds)Waits until the specified object is in the signaled state or the time-out interval elapses. | ||||||||||||||||
| public boolean | Returns: true if successful, false otherwise.
To get extended error information, call GetLastError().The name of the named pipe. The string must
include the name of the computer on which the server process is executing.
The following pipe name format is used:
lpNamedPipeName, int
A period may be used for the servername if the pipe is local. The number of milliseconds that the function will wait for
an instance of the named pipe to be available. nTimeOut)Waits until either a time-out interval elapses or an instance of the
specified named pipe is available for connection - i.e., the pipe's
server process has a pending | ||||||||||||||||
| public boolean | Returns: If the function succeeds, the return value is nonzero (TRUE). If the function fails, or is completing asynchronously, the return value is zero (FALSE). To get extended error information, call the GetLastError function.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). hFile,A pointer to the buffer containing the data to be written to
the file or device. lpBuffer, int The number of bytes to be written to the file or device. nNumberOfBytesToWrite, IntByReference A pointer to the variable that receives the number of bytes
written when using a synchronous hFile parameter. lpNumberOfBytesWritten, WinBase.A pointer to an OVERLAPPED structure is required if the hFile
parameter was opened with FILE_FLAG_OVERLAPPED, otherwise this
parameter can be NULL. lpOverlappedWrites data to the specified file or input/output (I/O) device. | ||||||||||||||||
| public boolean | Returns: If the function succeeds, the return value is nonzero. If the function fails, the return value is zero.The name of the section in which data is written. This section
name is typically the name of the calling application. lpAppName, String The new key names and associated values that are to be written
to the named section. This string is limited to 65,535 bytes.
Must be filled with zero or many lpString, String null-terminated
strings of the form key=value, appended by an
additional null byte to terminate the list.The name of the initialization file. If this parameter does
not contain a full path for the file, the function searches
the Windows directory for the file. If the file does not exist
and lpFileName does not contain a full path, the function
creates the file in the Windows directory. lpFileName)
| ||||||||||||||||
| public boolean | Returns: If the function successfully copies the string to the initialization file, the return value istrue.
If the function fails, or if it flushes the cached version of the
most recently accessed initialization file, the return value is
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. lpAppName, String 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 lpKeyName, String null, the entire section, including
all entries within the section, is deleted.A string to be written to the file. If this parameter is
lpString, String null, the key pointed to by the lpKeyName
parameter is deleted.The name of the initialization file. lpFileName)Copies a string into the specified section of an initialization file. | ||||||||||||||||
| public boolean | Returns: true if successful, false otherwise.
To get extended error information, call GetLastError().A handle to the process memory to be modified. hProcess,The base address in the specified process to which
data is written. lpBaseAddress, Pointer The buffer that contains data to be written in the
address space of the specified process. lpBuffer, int The number of bytes to be written to the specified process. nSize, IntByReference A variable that receives the number of bytes
transferred into the specified process. If lpNumberOfBytesWritten)null the parameter is ignored.Writes data to an area of memory in a specified process. |