get_environment_info (::quartus::misc)
The following table displays information for the get_environment_info Tcl command:
Tcl Package and Version |
Belongs to ::quartus::misc 1.0 |
|||
Syntax | get_environment_info [-h | -help] [-long_help] [-num_logical_processors] [-num_physical_processors] [-operating_system] | |||
Arguments | -h | -help | Short help | ||
-long_help | Long help with examples and possible return values | |||
-num_logical_processors | Option to return the number of available logical processors (cores including hyper-threading) | |||
-num_physical_processors | Option to return the number of available physical processors (sockets) | |||
-operating_system | Option to return the operating system name | |||
Description |
Returns information about the system environment depending on the options specified. |
|||
Example Usage |
# Get the number of physical processors available on my computer. get_environment_info -num_physical_processors |
|||
Return Value | Code Name | Code | String Return | |
TCL_OK | 0 | INFO: Operation successful | ||
TCL_ERROR | 1 | ERROR: At least one option is required. Specify at least one option. | ||
TCL_ERROR | 1 | ERROR: Multiple options used. Choose only one option for this command. |