Host machine queries

host.h Contains API for host related queries More...

Enumerations

enum  OS_HOST_CPU_ARCH_TYPE {
  OS_HOST_CPU_ARCH_TYPE_INVALID = 0,
  OS_HOST_CPU_ARCH_TYPE_IA32 = 1,
  OS_HOST_CPU_ARCH_TYPE_INTEL64 = 2
}

Functions

OS_RETURN_CODE OS_GetHostName (CHAR *buf, USIZE buflen)
OS_RETURN_CODE OS_GetHostCPUArch (OS_HOST_CPU_ARCH_TYPE *arch)
const char * OS_CPUArchToString (OS_HOST_CPU_ARCH_TYPE arch)
OS_RETURN_CODE OS_GetKernelRelease (CHAR *buf, USIZE bufsize)
OS_RETURN_CODE OS_GetOSName (CHAR *buf, USIZE bufsize)
OS_RETURN_CODE OS_GetOSVersion (CHAR *buf, USIZE bufsize)
OS_RETURN_CODE OS_ReadProcessorFrequency (UINT32 *freq)

Detailed Description


Enumeration Type Documentation

enum OS_HOST_CPU_ARCH_TYPE
 

CPU Architecture


Function Documentation

const char* OS_CPUArchToString OS_HOST_CPU_ARCH_TYPE  arch  ) 
 

Get a string representing a certain CPU arch.

Parameters:
[in] arch The architecture to get a string for it
Return values:
read-only string representing the CPU arch
Availability:
O/S: Windows, Linux & OS X*
CPU: All

OS_RETURN_CODE OS_GetHostCPUArch OS_HOST_CPU_ARCH_TYPE arch  ) 
 

Query CPU architecture.

Parameters:
[out] arch The architecture of this system's CPU
Return values:
OS_RETURN_CODE_NO_ERROR If the operation succeeded
OS_RETURN_CODE_QUERY_FAILED If the operation failed
Availability:
O/S: Windows, Linux & OS X*
CPU: All

OS_RETURN_CODE OS_GetHostName CHAR *  buf,
USIZE  buflen
 

Retrieves the host name of the current host - as known by this host

Parameters:
[out] buf Buffer to receive the host name
[in] buflen Size of buffer buf in bytes
Return values:
OS_RETURN_CODE_NO_ERROR If the operation succeeded
OS_RETURN_CODE_BUFFER_TOO_SHORT If the buffer buf is too short
OS_RETURN_CODE_QUERY_FAILED If the operation failed
Availability:
O/S: Windows, Linux & OS X*
CPU: All

OS_RETURN_CODE OS_GetKernelRelease CHAR *  buf,
USIZE  bufsize
 

Get kernel release description string.

Parameters:
[out] buf Buffer to receive the release string
[in] bufsize Size of buffer buf in bytes
Return values:
OS_RETURN_CODE_NO_ERROR If the operation succeeded
OS_RETURN_CODE_QUERY_FAILED If the operation failed
Availability:
O/S: Windows, Linux & OS X*
CPU: All

OS_RETURN_CODE OS_GetOSName CHAR *  buf,
USIZE  bufsize
 

Get the name of the operating system we're running on.

Parameters:
[out] buf Buffer to receive the OS name string
[in] bufsize Size of buffer buf in bytes
Return values:
OS_RETURN_CODE_NO_ERROR If the operation succeeded
OS_RETURN_CODE_QUERY_FAILED If the operation failed
Availability:
O/S: Windows, Linux & OS X*
CPU: All

OS_RETURN_CODE OS_GetOSVersion CHAR *  buf,
USIZE  bufsize
 

Get the version of the operating system we're running on.

Parameters:
[out] buf Buffer to receive the OS version string
[in] bufsize Size of buffer buf in bytes
Return values:
OS_RETURN_CODE_NO_ERROR If the operation succeeded
OS_RETURN_CODE_QUERY_FAILED If the operation failed
Availability:
O/S: Windows, Linux & OS X*
CPU: All

OS_RETURN_CODE OS_ReadProcessorFrequency UINT32 *  freq  ) 
 

Get CPU processor frequency in MHz.

Parameters:
[out] freq Frequency of the CPU
Return values:
OS_RETURN_CODE_NO_ERROR If the operation succeeded
OS_RETURN_CODE_QUERY_FAILED If the operation failed
Availability:
O/S: OS X*
CPU: All


Generated on Sun Jan 28 23:36:46 2018 for PinCRT by  doxygen 1.4.6