All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.sun.jna.platform.win32.Psapi Maven / Gradle / Ivy

There is a newer version: 1.50.0
Show newest version
/* Copyright (c) 2015 Andreas "PAX" L\u00FCck, All Rights Reserved
 *
 * The contents of this file is dual-licensed under 2
 * alternative Open Source/Free licenses: LGPL 2.1 or later and
 * Apache License 2.0. (starting with JNA version 4.0.0).
 *
 * You can freely decide which license you want to apply to
 * the project.
 *
 * You may obtain a copy of the LGPL License at:
 *
 * http://www.gnu.org/licenses/licenses.html
 *
 * A copy is also included in the downloadable source code package
 * containing JNA, in file "LGPL2.1".
 *
 * You may obtain a copy of the Apache License at:
 *
 * http://www.apache.org/licenses/
 *
 * A copy is also included in the downloadable source code package
 * containing JNA, in file "AL2.0".
 */
package com.sun.jna.platform.win32;

import java.util.List;

import com.sun.jna.Native;
import com.sun.jna.Pointer;
import com.sun.jna.Structure;
import com.sun.jna.Structure.FieldOrder;
import com.sun.jna.platform.win32.BaseTSD.SIZE_T;
import com.sun.jna.platform.win32.WinDef.DWORD;
import com.sun.jna.platform.win32.WinDef.HMODULE;
import com.sun.jna.platform.win32.WinNT.HANDLE;
import com.sun.jna.ptr.IntByReference;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

/**
 * The process status application programming interface (PSAPI) is a helper
 * library that makes it easier for you to obtain information about processes
 * and device drivers.
 *
 * @author Andreas "PAX" Lück, onkelpax-git[at]yahoo.de
 */
public interface Psapi extends StdCallLibrary {
    Psapi INSTANCE = Native.load("psapi", Psapi.class, W32APIOptions.DEFAULT_OPTIONS);

    /**
     * Retrieves the fully qualified path for the file containing the specified
     * module.
     *
     * @param process
     *            A handle to the process that contains the module.
     * @param module
     *            A handle to the module. If this parameter is NULL,
     *            GetModuleFileNameEx returns the path of the executable file of
     *            the process specified in hProcess.
     * @param lpFilename
     *            A pointer to a buffer that receives the fully qualified path
     *            to the module. If the size of the file name is larger than the
     *            value of the nSize parameter, the function succeeds but the
     *            file name is truncated and null-terminated.
     * @param nSize
     *            The size of the lpFilename buffer, in characters.
     * @return If the function succeeds, the return value specifies the length
     *         of the string copied to the buffer. If the function fails, the
     *         return value is zero. To get extended error information, call
     *         {@link Kernel32Util#getLastErrorMessage()}.
     */
    int GetModuleFileNameExA(HANDLE process, HANDLE module, byte[] lpFilename, int nSize);

    /**
     * Retrieves the fully qualified path for the file containing the specified
     * module.
     *
     * @param process
     *            A handle to the process that contains the module.
     * @param module
     *            A handle to the module. If this parameter is NULL,
     *            GetModuleFileNameEx returns the path of the executable file of
     *            the process specified in hProcess.
     * @param lpFilename
     *            A pointer to a buffer that receives the fully qualified path
     *            to the module. If the size of the file name is larger than the
     *            value of the nSize parameter, the function succeeds but the
     *            file name is truncated and null-terminated.
     * @param nSize
     *            The size of the lpFilename buffer, in characters.
     * @return If the function succeeds, the return value specifies the length
     *         of the string copied to the buffer. If the function fails, the
     *         return value is zero. To get extended error information, call
     *         {@link Kernel32Util#getLastErrorMessage()}.
     */
    int GetModuleFileNameExW(HANDLE process, HANDLE module, char[] lpFilename, int nSize);

    /**
     * Retrieves the fully qualified path for the file containing the specified
     * module.
     *
     * @param process
     *            A handle to the process that contains the module.
     * @param module
     *            A handle to the module. If this parameter is NULL,
     *            GetModuleFileNameEx returns the path of the executable file of
     *            the process specified in hProcess.
     * @param lpFilename
     *            A pointer to a buffer that receives the fully qualified path
     *            to the module. If the size of the file name is larger than the
     *            value of the nSize parameter, the function succeeds but the
     *            file name is truncated and null-terminated.
     * @param nSize
     *            The size of the lpFilename buffer, in characters.
     * @return If the function succeeds, the return value specifies the length
     *         of the string copied to the buffer. If the function fails, the
     *         return value is zero. To get extended error information, call
     *         {@link Kernel32Util#getLastErrorMessage()}.
     */
    int GetModuleFileNameEx(HANDLE process, HANDLE module, Pointer lpFilename, int nSize);

    /**
     *
     * The EnumProcessModules function is primarily designed for use by
     * debuggers and similar applications that must extract module information
     * from another process.
* If the module list in the target process is corrupted or not yet * initialized, or if the module list changes during the function call as a * result of DLLs being loaded or unloaded, EnumProcessModules may fail or * return incorrect information.
* It is a good idea to specify a large array of HMODULE values, because it * is hard to predict how many modules there will be in the process at the * time you call EnumProcessModules.
* To determine if the lphModule array is too small to hold all module * handles for the process, compare the value returned in lpcbNeeded with * the value specified in cb.
* If lpcbNeeded is greater than cb, increase the size of the array and call * EnumProcessModules again. To determine how many modules were enumerated * by the call to EnumProcessModules, divide the resulting value in the * lpcbNeeded parameter by sizeof(HMODULE).
* The EnumProcessModules function does not retrieve handles for modules * that were loaded with the LOAD_LIBRARY_AS_DATAFILE or similar flags. For * more information, see LoadLibraryEx.
* Do not call CloseHandle on any of the handles returned by this function. * The information comes from a snapshot, so there are no resources to be * freed.
* If this function is called from a 32-bit application running on WOW64, it * can only enumerate the modules of a 32-bit process.
* If the process is a 64-bit process, this function fails and the last * error code is ERROR_PARTIAL_COPY (299).
* To take a snapshot of specified processes and the heaps, modules, and * threads used by these processes, use the CreateToolhelp32Snapshot * function.
* Starting with Windows 7 and Windows Server 2008 R2, Psapi.h establishes * version numbers for the PSAPI functions.
* The PSAPI version number affects the name used to call the function and * the library that a program must load.
* If PSAPI_VERSION is 2 or greater, this function is defined as * K32EnumProcessModules in Psapi.h and exported in Kernel32.lib and * Kernel32.dll.
* If PSAPI_VERSION is 1, this function is defined as EnumProcessModules in * Psapi.h and exported in Psapi.lib and Psapi.dll as a wrapper that calls * K32EnumProcessModules.
* Programs that must run on earlier versions of Windows as well as Windows * 7 and later versions should always call this function as * EnumProcessModules.
* To ensure correct resolution of symbols, add Psapi.lib to the TARGETLIBS * macro and compile the program with -DPSAPI_VERSION=1.
* To use run-time dynamic linking, load Psapi.dll. * * @param hProcess * A handle to the process. * @param lphModule * An array that receives the list of module handles. * @param cb * The size of the lphModule array, in bytes. * @param lpcbNeeded * The number of bytes required to store all module handles in * the lphModule array. * @return 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. * @see MSDN/a> */ boolean EnumProcessModules(HANDLE hProcess, HMODULE[] lphModule, int cb, IntByReference lpcbNeeded); /** * To get information for the calling process, pass the handle returned by * GetCurrentProcess.
* The GetModuleInformation function does not retrieve information for * modules that were loaded with the LOAD_LIBRARY_AS_DATAFILE flag.
* For more information, see LoadLibraryEx.
* Starting with Windows 7 and Windows Server 2008 R2, Psapi.h establishes * version numbers for the PSAPI functions.
* The PSAPI version number affects the name used to call the function and * the library that a program must load.
* If PSAPI_VERSION is 2 or greater, this function is defined as * K32GetModuleInformation in Psapi.h and exported in Kernel32.lib and * Kernel32.dll.
* If PSAPI_VERSION is 1, this function is defined as * K32GetModuleInformation in Psapi.h and exported in Psapi.lib and * Psapi.dll as a wrapper that calls K32GetModuleInformation.
* Programs that must run on earlier versions of Windows as well as Windows * 7 and later versions should always call this function as * K32GetModuleInformation.
* To ensure correct resolution of symbols, add Psapi.lib to the TARGETLIBS * macro and compile the program with -DPSAPI_VERSION=1.
* To use run-time dynamic linking, load Psapi.dll. * * @param hProcess * A handle to the process that contains the module. The handle * must have the PROCESS_QUERY_INFORMATION and PROCESS_VM_READ * access rights. For more information, see Process Security and * Access Rights. * @param hModule * A handle to the module. * * @param lpmodinfo * A pointer to the MODULEINFO structure that receives * information about the module. * @param cb * The size of the MODULEINFO structure, in bytes. * @return 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. * @see
MSDN */ boolean GetModuleInformation(HANDLE hProcess, HMODULE hModule, MODULEINFO lpmodinfo, int cb); /** * @param hProcess * A handle to the process. The handle must have the * PROCESS_QUERY_INFORMATION or PROCESS_QUERY_LIMITED_INFORMATION * access right. For more information, see Process Security and * Access Rights.
* Windows Server 2003 and Windows XP: The handle must have the * PROCESS_QUERY_INFORMATION access right. * @param lpImageFileName * A pointer to a buffer that receives the full path to the * executable file. * @param nSize * The size of the lpImageFileName buffer, in characters. * @return If the function succeeds, the return value specifies the length * of the string copied to the buffer. If the function fails, the * return value is zero. To get extended error information, call * GetLastError. * @see MSDN */ int GetProcessImageFileName(HANDLE hProcess, char[] lpImageFileName, int nSize); /** * Retrieves the performance values contained in the * {@link PERFORMANCE_INFORMATION} structure. * * @param pPerformanceInformation * A pointer to a {@link PERFORMANCE_INFORMATION} structure that * receives the performance information. * @param cb * The size of the {@link PERFORMANCE_INFORMATION} structure, in * bytes. * @return If the function succeeds, the return value is TRUE. If the * function fails, the return value is FALSE. To get extended error * information, call {@link Kernel32Util#getLastErrorMessage()}. * @see MSDN */ boolean GetPerformanceInfo(PERFORMANCE_INFORMATION pPerformanceInformation, int cb); @FieldOrder({"lpBaseOfDll", "SizeOfImage", "EntryPoint"}) class MODULEINFO extends Structure { public Pointer EntryPoint; public Pointer lpBaseOfDll; public int SizeOfImage; } @FieldOrder({"cb", "CommitTotal", "CommitLimit", "CommitPeak", "PhysicalTotal", "PhysicalAvailable", "SystemCache", "KernelTotal", "KernelPaged", "KernelNonpaged", "PageSize", "HandleCount", "ProcessCount", "ThreadCount"}) class PERFORMANCE_INFORMATION extends Structure { public DWORD cb; public SIZE_T CommitTotal; public SIZE_T CommitLimit; public SIZE_T CommitPeak; public SIZE_T PhysicalTotal; public SIZE_T PhysicalAvailable; public SIZE_T SystemCache; public SIZE_T KernelTotal; public SIZE_T KernelPaged; public SIZE_T KernelNonpaged; public SIZE_T PageSize; public DWORD HandleCount; public DWORD ProcessCount; public DWORD ThreadCount; } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy