getSystemName()

Returns the name of the system.

Synopsis

string getSystemName([int systemId]);

Parameters

Parameters	Meaning
none	-

Return value

The function returns the name of the system or in the event of an error, "" (an empty string) will be returned.

Errors

Description

The function returns the system name of the specified system ID. If no system ID has been specified, the system name of its own system will be returned. If the system ID is not known or does not exist, "" (empty string) will be returned.

Example

main()
{
string sys, sys2, sys3, sys5
sys = getSystemName(); //sys == "SYSFive:" its own system
sys2 = getSystemName(2); //sys2 == "SYS_2:"
sys5 = getSystemName(5); //sys5 == "SYSFive:"
sys3 = getSystemName(9); //sys3 == "" no
//System 9 known
}

Relates to

Miscellaneous functions

Availability

UI, CTRL, DP