src/include/smbios_c/system_info.h File Reference

#include "smbios_c/compat.h"
#include "smbios_c/types.h"
Include dependency graph for system_info.h:

Go to the source code of this file.

Functions

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

Function Documentation

int DLL_SPEC smbios_get_library_version_major (  ) 

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

int DLL_SPEC smbios_get_library_version_minor (  ) 

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

const char* DLL_SPEC 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.

char* DLL_SPEC 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.
char* DLL_SPEC 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.
int DLL_SPEC 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.

int DLL_SPEC sysinfo_get_nvram_state_bytes ( int  user  ) 
char* DLL_SPEC 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.
char* DLL_SPEC 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.
char* DLL_SPEC 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.
int DLL_SPEC sysinfo_get_up_boot_flag (  ) 
char* DLL_SPEC 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.
int DLL_SPEC sysinfo_has_nvram_state_bytes (  ) 
int DLL_SPEC sysinfo_has_up_boot_flag (  ) 
int DLL_SPEC 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:
assetTag null-terminated new asset tag string
pass_ascii password to use in ascii (can be null for no pass)
pass_scancode keyboard scancode values for password (can be null for no pass)
Returns:
0 == success -1 == general failure -2 == password incorrect
void DLL_SPEC sysinfo_set_nvram_state_bytes ( int  value,
int  user 
)
int DLL_SPEC sysinfo_set_property_ownership_tag ( const char *  newTag,
const char *  pass_ascii,
const char *  pass_scancode 
)

Set system property ownership tag.

Parameters:
newTag buffer holding new tag
pass_ascii password as ascii bytes
pass_scancode password as keyboard scancodes
Returns:
0 on success, -1 general failure, -2 bad password
int DLL_SPEC sysinfo_set_up_boot_flag ( int  state  ) 
const char* DLL_SPEC 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.

void DLL_SPEC sysinfo_string_free ( void *   ) 

Free string.

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

Generated on Wed Jul 28 08:16:02 2010 for libsmbios_c library by  doxygen 1.6.3