oshi.jna.platform.windows

Interface Pdh

All Superinterfaces:

com.sun.jna.Library

public interface Pdh
extends com.sun.jna.Library

Windows Performance Data Helper. This class should be considered non-API as it may be removed if/when its code is incorporated into the JNA project.

Author:

widdis[at]gmail[dot]com

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Pdh.PdhFmtCounterValue Holds the return value of a formatted data query.
static class	Pdh.ValueUnion Union included in return value of Pdh.PdhFmtCounterValue

Nested classes/interfaces inherited from interface com.sun.jna.Library

com.sun.jna.Library.Handler

Field Summary

Fields

Modifier and Type	Field and Description
static Pdh	INSTANCE
static int	PDH_FMT_1000
static int	PDH_FMT_DOUBLE
static int	PDH_FMT_LARGE
static int	PDH_FMT_LONG
static int	PDH_FMT_NOCAP100
static int	PDH_FMT_NOSCALE

Fields inherited from interface com.sun.jna.Library

OPTION_ALLOW_OBJECTS, OPTION_CALLING_CONVENTION, OPTION_CLASSLOADER, OPTION_FUNCTION_MAPPER, OPTION_INVOCATION_MAPPER, OPTION_OPEN_FLAGS, OPTION_STRING_ENCODING, OPTION_STRUCTURE_ALIGNMENT, OPTION_TYPE_MAPPER

Method Summary

Modifier and Type	Method and Description
int	PdhAddEnglishCounterA(com.sun.jna.Pointer pointer, String counterPath, com.sun.jna.ptr.IntByReference dwUserData, com.sun.jna.ptr.PointerByReference phCounter) Adds the specified language-neutral counter to the query.
int	PdhCloseQuery(com.sun.jna.Pointer pointer) Closes all counters contained in the specified query, closes all handles related to the query, and frees all memory associated with the query.
int	PdhCollectQueryData(com.sun.jna.Pointer pointer) Collects the current raw data value for all counters in the specified query and updates the status code of each counter.
int	PdhGetFormattedCounterValue(com.sun.jna.Pointer pointer, int dwFormat, com.sun.jna.ptr.IntByReference lpdwType, Pdh.PdhFmtCounterValue pValue) Computes a displayable value for the specified counter.
int	PdhOpenQuery(String szDataSource, com.sun.jna.ptr.IntByReference dwUserData, com.sun.jna.ptr.PointerByReference phQuery) Creates a new query that is used to manage the collection of performance data.

Field Detail

INSTANCE

static final Pdh INSTANCE

PDH_FMT_LONG

static final int PDH_FMT_LONG

See Also:

Constant Field Values

PDH_FMT_DOUBLE

static final int PDH_FMT_DOUBLE

See Also:

Constant Field Values

PDH_FMT_LARGE

static final int PDH_FMT_LARGE

See Also:

Constant Field Values

PDH_FMT_NOSCALE

static final int PDH_FMT_NOSCALE

See Also:

Constant Field Values

PDH_FMT_1000

static final int PDH_FMT_1000

See Also:

Constant Field Values

PDH_FMT_NOCAP100

static final int PDH_FMT_NOCAP100

See Also:

Constant Field Values

Method Detail

PdhOpenQuery

int PdhOpenQuery(String szDataSource,
                 com.sun.jna.ptr.IntByReference dwUserData,
                 com.sun.jna.ptr.PointerByReference phQuery)

Creates a new query that is used to manage the collection of performance data.

Parameters:

szDataSource - Null-terminated string that specifies the name of the log file from which to retrieve performance data. If NULL, performance data is collected from a real-time data source.

dwUserData - User-defined value to associate with this query.

phQuery - Handle to the query. You use this handle in subsequent calls.

Returns:

If the function succeeds, the return value is zero. If the function fails, the return value is a system error code or a PDH error code.

PdhAddEnglishCounterA

int PdhAddEnglishCounterA(com.sun.jna.Pointer pointer,
                          String counterPath,
                          com.sun.jna.ptr.IntByReference dwUserData,
                          com.sun.jna.ptr.PointerByReference phCounter)

Adds the specified language-neutral counter to the query.

Parameters:

pointer - Handle to the query to which you want to add the counter. This handle is returned by the PdhOpenQuery(String, IntByReference, PointerByReference) function.

counterPath - Null-terminated string that contains the counter path.

dwUserData - User-defined value.

phCounter - Handle to the counter that was added to the query. You may need to reference this handle in subsequent calls.

Returns:

If the function succeeds, the return value is zero. If the function fails, the return value is a system error code or a PDH error code.

PdhCollectQueryData

int PdhCollectQueryData(com.sun.jna.Pointer pointer)

Collects the current raw data value for all counters in the specified query and updates the status code of each counter.

Parameters:

pointer - Handle of the query for which you want to collect data. The PdhOpenQuery(String, IntByReference, PointerByReference) function returns this handle.

Returns:

If the function succeeds, the return value is nonzero. If the function fails, the return value is zero and errno is set.

PdhGetFormattedCounterValue

int PdhGetFormattedCounterValue(com.sun.jna.Pointer pointer,
                                int dwFormat,
                                com.sun.jna.ptr.IntByReference lpdwType,
                                Pdh.PdhFmtCounterValue pValue)

Computes a displayable value for the specified counter.

Parameters:

pointer - Handle of the counter for which you want to compute a displayable value. The PdhAddEnglishCounterA(Pointer, String, IntByReference, PointerByReference) function returns this handle.

dwFormat - Determines the data type of the formatted value.

lpdwType - Receives the counter type. This parameter is optional.

pValue - A Pdh.PdhFmtCounterValue structure that receives the counter value.

Returns:

If the function succeeds, the return value is zero. If the function fails, the return value is a system error code or a PDH error code.

PdhCloseQuery

int PdhCloseQuery(com.sun.jna.Pointer pointer)

Closes all counters contained in the specified query, closes all handles related to the query, and frees all memory associated with the query.

Parameters:

pointer - Handle to the query to close. This handle is returned by the PdhOpenQuery(String, IntByReference, PointerByReference) function.

Returns:

If the function succeeds, the return value is zero. If the function fails, the return value is a system error code or a PDH error code.