xtd::system_report Class Reference

Inheritance diagram for xtd::system_report:

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.

Public Types
enum class	reports {   stack_trace ,   libraries ,   processor ,   operating_system ,   compiler ,   language ,   locale ,   toolkit ,   environment_variables ,   special_folders ,   system_colors ,   generic_font_families ,   system_fonts ,   screens ,   system_informations ,   all ,   ui ,   minimal ,   standard ,   diagnostic ,   sensitive ,   safe ,   full }
	Specifies enumerated constants used by xtd::system_report::to_json, xtd::system_report::to_string and xtd::system_report::to_xml methods to generate reports. More...

Public Aliases
using	environment_variable_collection
	Represents an environment variables collection.
using	special_folder_collection
	Represents a folders collection.
using	system_color_collection
	Represents a colors collection.
using	system_font_collection
	Represents a fonts collection.
using	system_font_family_collection
	Represents a font families collection.
using	system_information_collection
	Represents a system informations collection.

Public Static Properties
static xtd::compiler	compiler () noexcept
	Gets an xtd::compiler object that contains the current compiler identifier and version number.
static environment_variable_collection	environment_variables () noexcept
	Retrieves all environment variable names and their values from the current process.
static const system_font_family_collection &	generic_font_families () noexcept
	Gets a generic font_families.
static xtd::cpp_language	language () noexcept
	Gets an xtd::cpp_language object that contains the current c++ standard identifier and version number.
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.
static xtd::operating_system	operating_system () noexcept
	Gets an xtd::operating_system object that contains the current platform identifier and version number.
static xtd::processor	processor () noexcept
	Gets an xtd::processor object that contains the processor identifier.
static xtd::array< xtd::forms::screen >	screens () noexcept
	Gets an array of all displays on the system.
static const special_folder_collection &	special_folders () noexcept
	Gets directory paths to system special folders.
static xtd::diagnostics::stack_trace	stack_trace () noexcept
	Gets current stack trace information.
static xtd::diagnostics::stack_trace	stack_trace (size_t skip_frames) noexcept
	Gets current stack trace information with specified number of frames to skip.
static const system_color_collection &	system_colors () noexcept
	Gets system colors.
static const system_font_collection &	system_fonts () noexcept
	Gets system fonts.
static system_information_collection	system_informations () noexcept
	Gets system informations.
static xtd::toolkit	toolkit () noexcept
	Gets an xtd::toolkit object that contains the current toolkit identifier and version number.
static const environment::xtd_library_collection &	xtd_libraries () noexcept
	Gets xtd libraries informations.

Public Static Methods
static xtd::string	to_json () noexcept
	Generates json format string report.
static xtd::string	to_json (reports reports) noexcept
	Generates json format string report.
static xtd::string	to_string () noexcept
	Generates string report.
static xtd::string	to_string (reports reports) noexcept
	Generates string report.
static xtd::string	to_xml () noexcept
	Generates xml format string report.
static xtd::string	to_xml (reports reports) noexcept
	Generates xml format string report.

Member Typedef Documentation

environment_variable_collection

using xtd::system_report::environment_variable_collection

Represents an environment variables collection.

special_folder_collection

using xtd::system_report::special_folder_collection

Represents a folders collection.

system_color_collection

using xtd::system_report::system_color_collection

Represents a colors collection.

system_font_collection

using xtd::system_report::system_font_collection

Represents a fonts collection.

system_font_family_collection

using xtd::system_report::system_font_family_collection

Represents a font families collection.

system_information_collection

using xtd::system_report::system_information_collection

Represents a system informations collection.

Member Enumeration Documentation

reports

enum class xtd::system_report::reports

strong

Specifies enumerated constants used by xtd::system_report::to_json, xtd::system_report::to_string and xtd::system_report::to_xml methods to generate reports.

Enumerator
stack_trace	Stack trace information.
libraries	xtd libraries informations collection.
processor	The procesor identifier.
operating_system	The platform identifier and version number.
compiler	The compiler identifier and version number.
language	The c++ standard identifier and version number.
locale	The global C++ locale.
toolkit	The toolkit identifier and version number.
environment_variables	Environment variable names and their values.
special_folders	Directory paths to system special folders.
system_colors	System colors collection.
generic_font_families	Generic font families collection.
system_fonts	System fonsts collection.
screens	Displays on the system.
system_informations	System informations collection.
all	All reports.
ui	UI report.
minimal	Minimal report. Remarks Typically used for rapid logging.
standard	Standard report. Remarks Typically used for class bug report.
diagnostic	Diagnostic report. Remarks Typically used for advanced development debug. Does not include sensitive information by default.
sensitive	Sensitive report. Warning Contains sensitive information such as environment variables and user-specific paths.
safe	Safe report. Remarks Includes all non-sensitive information.
full	Standard report. Remarks Includes all available information, including sensitive data.

Member Function Documentation

compiler()

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()

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()

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

staticnoexcept

Gets a generic font_families.

Returns

Generic font families collection.

language()

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()

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()

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()

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()

xtd::array< 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.

special_folders()

const special_folder_collection & xtd::system_report::special_folders ( )

staticnoexcept

Gets directory paths to system special folders.

Returns

A special_folder_collection collection containing directory paths to system special folders.

stack_trace() [1/2]

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]

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_frames

The number of frames to skip.

Returns

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

system_colors()

const system_color_collection & xtd::system_report::system_colors ( )

staticnoexcept

Gets system colors.

Returns

A system_color_collection collection containing system colors.

system_fonts()

const system_font_collection & xtd::system_report::system_fonts ( )

staticnoexcept

Gets system fonts.

Returns

A system_font_collection collection containing system fonst.

system_informations()

system_information_collection xtd::system_report::system_informations ( )

staticnoexcept

Gets system informations.

Returns

A system_information_collection collection containing system informations.

toolkit()

xtd::toolkit xtd::system_report::toolkit ( )

staticnoexcept

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

Returns

An object that contains the toolkit identifier and version number.

xtd_libraries()

const environment::xtd_library_collection & xtd::system_report::xtd_libraries ( )

staticnoexcept

Gets xtd libraries informations.

Returns

A environment::xtd_library_collection collection containing xtd libraries informations.

to_json() [1/2]

xtd::string xtd::system_report::to_json ( )

staticnoexcept

Generates json format string report.

Returns

An json format string report.

Todo

Implement json report

to_json() [2/2]

xtd::string xtd::system_report::to_json ( reports reports )

staticnoexcept

Generates json format string report.

Parameters

reports

A bitwise combination of the xtd::system_report::reports values.

Returns

An json format string report.

Todo

Implement json report

to_string() [1/2]

xtd::string xtd::system_report::to_string ( )

staticnoexcept

Generates string report.

Returns

A string report.

to_string() [2/2]

xtd::string xtd::system_report::to_string ( reports reports )

staticnoexcept

Generates string report.

Parameters

reports

A bitwise combination of the xtd::system_report::reports values.

Returns

A string report.

to_xml() [1/2]

xtd::string xtd::system_report::to_xml ( )

staticnoexcept

Generates xml format string report.

Returns

An xml format string report.

Todo

Implement xml report

to_xml() [2/2]

xtd::string xtd::system_report::to_xml ( reports reports )

staticnoexcept

Generates xml format string report.

Parameters

reports

A bitwise combination of the xtd::system_report::reports values.

Returns

An xml format string report.

Todo

Implement xml report

---

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

• xtd.forms/include/xtd/system_report.hpp