Class Kernel32FFM

java.lang.Object

oshi.ffm.ForeignFunctions

oshi.ffm.windows.WindowsForeignFunctions

oshi.ffm.windows.Kernel32FFM

public final class Kernel32FFM
extends WindowsForeignFunctions

Field Summary

Fields inherited from class ForeignFunctions

CAPTURE_CALL_STATE, CAPTURED_STATE_LAYOUT, ERRNO_HANDLE, LIBRARY_ARENA, LINKER, SYMBOL_LOOKUP

Constructor Summary

Constructors

Constructor	Description
Kernel32FFM()

Method Summary

Modifier and Type	Method	Description
static OptionalInt	CloseHandle(MemorySegment handle)
static Optional<MemorySegment>	FindFirstVolume(MemorySegment lpszVolumeName, int cchBufferLength)
static OptionalInt	FindNextVolume(MemorySegment hFindVolume, MemorySegment lpszVolumeName, int cchBufferLength)
static OptionalInt	FindVolumeClose(MemorySegment hFindVolume)
static Optional<String>	GetComputerName()
static Optional<String>	GetComputerNameEx()
static Optional<MemorySegment>	GetCurrentProcess()
static OptionalInt	GetCurrentProcessId()
static OptionalInt	GetCurrentThreadId()
static OptionalInt	GetDiskFreeSpaceEx(MemorySegment lpDirectoryName, MemorySegment lpFreeBytesAvailableToCaller, MemorySegment lpTotalNumberOfBytes, MemorySegment lpTotalNumberOfFreeBytes)
static OptionalInt	GetDriveType(MemorySegment lpRootPathName)
static OptionalInt	GetLastError()
static OptionalLong	GetTickCount()
static OptionalInt	GetVolumeInformation(MemorySegment lpRootPathName, MemorySegment lpVolumeNameBuffer, int nVolumeNameSize, MemorySegment lpVolumeSerialNumber, MemorySegment lpMaximumComponentLength, MemorySegment lpFileSystemFlags, MemorySegment lpFileSystemNameBuffer, int nFileSystemNameSize)
static OptionalInt	GetVolumeNameForVolumeMountPoint(MemorySegment lpszVolumeMountPoint, MemorySegment lpszVolumeName, int cchBufferLength)	Retrieves a volume GUID path for the volume that is associated with the specified volume mount point.
static OptionalInt	GetVolumePathNamesForVolumeName(MemorySegment lpszVolumeName, MemorySegment lpszVolumePathNames, int cchBufferLength, MemorySegment lpcchReturnLength)
static OptionalInt	SetErrorMode(int uMode)

Methods inherited from class WindowsForeignFunctions

checkSuccess, isSuccess, readAnsiString, readWideString, setupTokenPrivileges, toWideString

Methods inherited from class ForeignFunctions

downcall, getByteArrayFromNativePointer, getErrno, getStringFromNativePointer, getStructFromNativePointer, lib, libraryLookup

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Kernel32FFM

public Kernel32FFM()

Method Details

CloseHandle

public static OptionalInt CloseHandle(MemorySegment handle)

FindFirstVolume

public static Optional<MemorySegment> FindFirstVolume(MemorySegment lpszVolumeName,
 int cchBufferLength)

FindNextVolume

public static OptionalInt FindNextVolume(MemorySegment hFindVolume,
 MemorySegment lpszVolumeName,
 int cchBufferLength)

FindVolumeClose

public static OptionalInt FindVolumeClose(MemorySegment hFindVolume)

GetComputerName

public static Optional<String> GetComputerName()

GetComputerNameEx

public static Optional<String> GetComputerNameEx()

GetCurrentProcess

public static Optional<MemorySegment> GetCurrentProcess()

GetCurrentProcessId

public static OptionalInt GetCurrentProcessId()

GetLastError

public static OptionalInt GetLastError()

GetCurrentThreadId

public static OptionalInt GetCurrentThreadId()

GetDiskFreeSpaceEx

public static OptionalInt GetDiskFreeSpaceEx(MemorySegment lpDirectoryName,
 MemorySegment lpFreeBytesAvailableToCaller,
 MemorySegment lpTotalNumberOfBytes,
 MemorySegment lpTotalNumberOfFreeBytes)

GetDriveType

public static OptionalInt GetDriveType(MemorySegment lpRootPathName)

GetVolumeInformation

public static OptionalInt GetVolumeInformation(MemorySegment lpRootPathName,
 MemorySegment lpVolumeNameBuffer,
 int nVolumeNameSize,
 MemorySegment lpVolumeSerialNumber,
 MemorySegment lpMaximumComponentLength,
 MemorySegment lpFileSystemFlags,
 MemorySegment lpFileSystemNameBuffer,
 int nFileSystemNameSize)

GetVolumePathNamesForVolumeName

public static OptionalInt GetVolumePathNamesForVolumeName(MemorySegment lpszVolumeName,
 MemorySegment lpszVolumePathNames,
 int cchBufferLength,
 MemorySegment lpcchReturnLength)

GetTickCount

public static OptionalLong GetTickCount()

SetErrorMode

public static OptionalInt SetErrorMode(int uMode)

GetVolumeNameForVolumeMountPoint

public static OptionalInt GetVolumeNameForVolumeMountPoint(MemorySegment lpszVolumeMountPoint,
 MemorySegment lpszVolumeName,
 int cchBufferLength)

Retrieves a volume GUID path for the volume that is associated with the specified volume mount point.

Parameters:

lpszVolumeMountPoint - the path of a mounted folder or a drive letter (e.g., "C:\\")

lpszVolumeName - buffer to receive the volume GUID path

cchBufferLength - size of the buffer in characters

Returns:

nonzero if successful, zero otherwise