xtd 0.2.0
xtd::system_report Class Referencefinal

Definition

Provides system report about the current system environment.

Library
xtd
Remarks
The system_report class provides static properties that can be used to get information and creates a string and xml format string reports about the current system environment.

Alias

using environment_variable_collection = std::vector< std::pair< xtd::ustring, xtd::ustring > >
 Represents an environment variables collection. More...
 
using special_folder_collection = std::vector< std::pair< xtd::ustring, xtd::ustring > >
 Represents a folders collection. More...
 
using system_color_collection = std::vector< std::pair< xtd::ustring, xtd::drawing::color > >
 Represents a colors collection. More...
 
using system_font_collection = std::vector< std::pair< xtd::ustring, xtd::drawing::font > >
 Represents a fonts collection. More...
 
using system_font_family_collection = std::vector< std::pair< xtd::ustring, xtd::drawing::font_family > >
 Represents a font families collection. More...
 
using system_information_collection = std::vector< std::pair< xtd::ustring, xtd::ustring > >
 Represents a system informations collection. More...
 

Properties

static xtd::compiler compiler () noexcept
 Gets an xtd::compiler object that contains the current compiler identifier and version number. More...
 
static environment_variable_collection environment_variables () noexcept
 Retrieves all environment variable names and their values from the current process. More...
 
static const system_font_family_collectiongeneric_font_families () noexcept
 Gets a generic font_families. More...
 
static xtd::cpp_language language () noexcept
 Gets an xtd::cpp_language object that contains the current c++ standard identifier and version number. More...
 
static std::locale locale () noexcept
 Gets a copy of the global C++ locale, which is the locale most recently used as the argument to See std::locale::global or a copy of See std::locale::classic() if no call to See std::locale::global has been made. More...
 
static xtd::operating_system operating_system () noexcept
 Gets an xtd::operating_system object that contains the current platform identifier and version number. More...
 
static xtd::processor processor () noexcept
 Gets an xtd::processor object that contains the processor identifier. More...
 
static std::vector< xtd::forms::screenscreens () noexcept
 Gets an array of all displays on the system. More...
 
static const special_folder_collectionspecial_folders () noexcept
 
static xtd::diagnostics::stack_trace stack_trace () noexcept
 Gets current stack trace information. More...
 
static xtd::diagnostics::stack_trace stack_trace (size_t skip_frames) noexcept
 Gets current stack trace information with specified number of frames to skip. More...
 
static const system_color_collectionsystem_colors () noexcept
 
static const system_font_collectionsystem_fonts () noexcept
 
static system_information_collection system_informations () noexcept
 
static xtd::toolkit toolkit () noexcept
 
static const environment::xtd_library_collectionxtd_libraries () noexcept
 

Methods

static xtd::ustring to_json () noexcept
 Generates json format string report. More...
 
static xtd::ustring to_string () noexcept
 Generates string report. More...
 
static xtd::ustring to_xml () noexcept
 Generates xml format string report. More...
 

Member Typedef Documentation

◆ environment_variable_collection

Represents an environment variables collection.

◆ special_folder_collection

Represents a folders collection.

◆ system_color_collection

Represents a colors collection.

◆ system_font_collection

Represents a fonts collection.

◆ system_font_family_collection

Represents a font families collection.

◆ system_information_collection

Represents a system informations collection.

Member Function Documentation

◆ compiler()

static xtd::compiler xtd::system_report::compiler ( )
staticnoexcept

Gets an xtd::compiler object that contains the current compiler identifier and version number.

Returns
An object that contains the compiler identifier and version number.

◆ environment_variables()

static environment_variable_collection xtd::system_report::environment_variables ( )
staticnoexcept

Retrieves all environment variable names and their values from the current process.

Returns
std::map A dictionary that contains all environment variable names and their values; otherwise, an empty dictionary if no environment variables are found.

◆ generic_font_families()

static const system_font_family_collection& xtd::system_report::generic_font_families ( )
staticnoexcept

Gets a generic font_families.

Returns
Generic font families collection.

◆ language()

static xtd::cpp_language xtd::system_report::language ( )
staticnoexcept

Gets an xtd::cpp_language object that contains the current c++ standard identifier and version number.

Returns
An object that contains the c++ standard identifier and version number.

◆ locale()

static std::locale xtd::system_report::locale ( )
staticnoexcept

Gets a copy of the global C++ locale, which is the locale most recently used as the argument to See std::locale::global or a copy of See std::locale::classic() if no call to See std::locale::global has been made.

Returns
A copy of the global C++ locale.
Remarks
See std::locale for more information.

◆ operating_system()

static xtd::operating_system xtd::system_report::operating_system ( )
staticnoexcept

Gets an xtd::operating_system object that contains the current platform identifier and version number.

Returns
An object that contains the platform identifier and version number.

◆ processor()

static xtd::processor xtd::system_report::processor ( )
staticnoexcept

Gets an xtd::processor object that contains the processor identifier.

Returns
An object that contains the procesor identifier.

◆ screens()

static std::vector<xtd::forms::screen> xtd::system_report::screens ( )
staticnoexcept

Gets an array of all displays on the system.

Returns
An array of type screen, containing all displays on the system.

◆ stack_trace() [1/2]

static xtd::diagnostics::stack_trace xtd::system_report::stack_trace ( )
staticnoexcept

Gets current stack trace information.

Returns
A string containing stack trace information. This value can be empty "".

◆ stack_trace() [2/2]

static xtd::diagnostics::stack_trace xtd::system_report::stack_trace ( size_t  skip_frames)
staticnoexcept

Gets current stack trace information with specified number of frames to skip.

Parameters
skip_framesThe number of frames to skip.
Returns
A string containing stack trace information. This value can be empty "".

◆ to_json()

static xtd::ustring xtd::system_report::to_json ( )
staticnoexcept

Generates json format string report.

Returns
An json format string report.
Todo:
Implement json report
Examples:
system_report.cpp.

◆ to_string()

static xtd::ustring xtd::system_report::to_string ( )
staticnoexcept

Generates string report.

Returns
A string report.
Examples:
system_report.cpp.

◆ to_xml()

static xtd::ustring xtd::system_report::to_xml ( )
staticnoexcept

Generates xml format string report.

Returns
An xml format string report.
Todo:
Implement xml report
Examples:
system_report.cpp.

The documentation for this class was generated from the following file: