libsmbios_c library
Functions
system_info.h File Reference
#include "smbios_c/compat.h"
#include "smbios_c/types.h"

Go to the source code of this file.

Functions

LIBSMBIOS_C_DLL_SPEC const char * smbios_get_library_version_string ()
 Return a string representing the version of the libsmbios library. More...
 
LIBSMBIOS_C_DLL_SPEC int smbios_get_library_version_major ()
 Return a number representing the major version of the libsmbios library. More...
 
LIBSMBIOS_C_DLL_SPEC int smbios_get_library_version_minor ()
 Return a number representing the minor version of the libsmbios library. More...
 
LIBSMBIOS_C_DLL_SPEC int sysinfo_get_dell_system_id ()
 Return the Dell System ID Byte or Word. More...
 
LIBSMBIOS_C_DLL_SPEC char * sysinfo_get_vendor_name ()
 Return a buffer containing the system vendor name. More...
 
LIBSMBIOS_C_DLL_SPEC char * sysinfo_get_system_name ()
 Return a buffer containing the system name. More...
 
LIBSMBIOS_C_DLL_SPEC char * sysinfo_get_bios_version ()
 Return a buffer containing the system bios version string. More...
 
LIBSMBIOS_C_DLL_SPEC char * sysinfo_get_asset_tag ()
 Return a buffer containing the system asset tag string. More...
 
LIBSMBIOS_C_DLL_SPEC char * sysinfo_get_service_tag ()
 Return a buffer containing the system service tag string. More...
 
LIBSMBIOS_C_DLL_SPEC char * sysinfo_get_property_ownership_tag ()
 copy property ownership tag into user-supplied buffer. More...
 
LIBSMBIOS_C_DLL_SPEC int sysinfo_set_property_ownership_tag (const char *newTag, const char *pass_ascii, const char *pass_scancode)
 Set system property ownership tag. More...
 
LIBSMBIOS_C_DLL_SPEC int sysinfo_set_asset_tag (const char *assetTag, const char *pass_ascii, const char *pass_scancode)
 set the system asset tag. More...
 
LIBSMBIOS_C_DLL_SPEC const char * sysinfo_strerror ()
 Returns string describing the last error condition. More...
 
LIBSMBIOS_C_DLL_SPEC void sysinfo_string_free (void *)
 Free string. More...
 
LIBSMBIOS_C_DLL_SPEC int sysinfo_has_nvram_state_bytes ()
 
LIBSMBIOS_C_DLL_SPEC int sysinfo_get_nvram_state_bytes (int user)
 
LIBSMBIOS_C_DLL_SPEC void sysinfo_set_nvram_state_bytes (int value, int user)
 
LIBSMBIOS_C_DLL_SPEC int sysinfo_has_up_boot_flag ()
 
LIBSMBIOS_C_DLL_SPEC int sysinfo_set_up_boot_flag (int state)
 
LIBSMBIOS_C_DLL_SPEC int sysinfo_get_up_boot_flag ()
 

Function Documentation

LIBSMBIOS_C_DLL_SPEC int smbios_get_library_version_major ( )

Return a number representing the major version of the libsmbios library.

LIBSMBIOS_C_DLL_SPEC int smbios_get_library_version_minor ( )

Return a number representing the minor version of the libsmbios library.

LIBSMBIOS_C_DLL_SPEC const char* smbios_get_library_version_string ( )

Return a string representing the version of the libsmbios library.

This string is statically allocated in the library, so there is no need to free it when done.

LIBSMBIOS_C_DLL_SPEC char* sysinfo_get_asset_tag ( )

Return a buffer containing the system asset tag string.

Return value must be de-allocated using sysinfo_string_free(), or memory will leak.

Returns
pointer to buffer containing system asset tag string. Deallocate with sysinfo_string_free() when done.
LIBSMBIOS_C_DLL_SPEC char* sysinfo_get_bios_version ( )

Return a buffer containing the system bios version string.

Return value must be de-allocated using sysinfo_string_free(), or memory will leak.

Returns
pointer to buffer containing system bios version string. Deallocate with sysinfo_string_free() when done.
LIBSMBIOS_C_DLL_SPEC int sysinfo_get_dell_system_id ( )

Return the Dell System ID Byte or Word.

The Dell System ID is a unique number allocated to each Dell System (server, desktop, workstation, or laptop) that uniquely identifies that system within Dell's product line.

LIBSMBIOS_C_DLL_SPEC int sysinfo_get_nvram_state_bytes ( int  user)
LIBSMBIOS_C_DLL_SPEC char* sysinfo_get_property_ownership_tag ( )

copy property ownership tag into user-supplied buffer.

Return value must be de-allocated using sysinfo_string_free(), or memory will leak.

Returns
pointer to buffer containing system property ownership tag string. Deallocate with sysinfo_string_free() when done.
LIBSMBIOS_C_DLL_SPEC char* sysinfo_get_service_tag ( )

Return a buffer containing the system service tag string.

Return value must be de-allocated using sysinfo_string_free(), or memory will leak.

Returns
pointer to buffer containing system service tag string. Deallocate with sysinfo_string_free() when done.
LIBSMBIOS_C_DLL_SPEC char* sysinfo_get_system_name ( )

Return a buffer containing the system name.

Return value must be de-allocated using sysinfo_string_free(), or memory will leak.

Returns
pointer to buffer containing system name. Deallocate with sysinfo_string_free() when done.
LIBSMBIOS_C_DLL_SPEC int sysinfo_get_up_boot_flag ( )
LIBSMBIOS_C_DLL_SPEC char* sysinfo_get_vendor_name ( )

Return a buffer containing the system vendor name.

Return value must be de-allocated using sysinfo_string_free(), or memory will leak.

Returns
pointer to buffer containing vendor name. Deallocate with sysinfo_string_free() when done.
LIBSMBIOS_C_DLL_SPEC int sysinfo_has_nvram_state_bytes ( )
LIBSMBIOS_C_DLL_SPEC int sysinfo_has_up_boot_flag ( )
LIBSMBIOS_C_DLL_SPEC int sysinfo_set_asset_tag ( const char *  assetTag,
const char *  pass_ascii,
const char *  pass_scancode 
)

set the system asset tag.

Note some systems store password in ascii and some store keyboard scancodes. Thus you must pass both.

Parameters
assetTagnull-terminated new asset tag string
pass_asciipassword to use in ascii (can be null for no pass)
pass_scancodekeyboard scancode values for password (can be null for no pass)
Returns
0 == success -1 == general failure -2 == password incorrect
LIBSMBIOS_C_DLL_SPEC void sysinfo_set_nvram_state_bytes ( int  value,
int  user 
)
LIBSMBIOS_C_DLL_SPEC int sysinfo_set_property_ownership_tag ( const char *  newTag,
const char *  pass_ascii,
const char *  pass_scancode 
)

Set system property ownership tag.

Parameters
newTagbuffer holding new tag
pass_asciipassword as ascii bytes
pass_scancodepassword as keyboard scancodes
Returns
0 on success, -1 general failure, -2 bad password
LIBSMBIOS_C_DLL_SPEC int sysinfo_set_up_boot_flag ( int  state)
LIBSMBIOS_C_DLL_SPEC const char* sysinfo_strerror ( )

Returns string describing the last error condition.

Can return 0. The buffer used is guaranteed to be valid until the next call to any sysinfo_* function. Copy the contents if you need it longer.

LIBSMBIOS_C_DLL_SPEC void sysinfo_string_free ( void *  )

Free string.

Use this function to deallocate the strings returned by other functions in this header.