post_message (::quartus::misc)
The following table displays information for the post_message Tcl command:
Tcl Package and Version |
Belongs to ::quartus::misc 1.0 |
|||
Syntax |
post_message [-h | -help] [-long_help]
[-type
<info|extra_info|warning|critical_warning|error>
]
[ <string> ] |
|||
Arguments | -h | -help | Short help | ||
-long_help | Long help with examples and possible return values | |||
-type <info|extra_info|warning|critical_warning|error> | Type of message to display | |||
<string> | Message to be displayed | |||
Description |
Displays messages and sub-messages of the specified type. The message type can be "info", "warning", "critical_warning", or "error". If you do not use the -type option, the default message type is "info". The "extra_info" type is deprecated. Messages with this type will not be displayed. Use the "info" type instead. Use the -submsgs option to group messages indented under a message. The -submsgs option posts each string in a Tcl list of strings as a sub-message. The sub-messages have the same message type as the main message. |
|||
Example Usage |
# Display an error message post_message -type error "Can't open file test.tcl" # Display an info message post_message "Generated output file: test.out" # OR post_message -type info "Generated output file: test.out" # Display an info message with a sub-message post_message "Generated output file: test.out" -submsgs [list "Ouput file saved in project directory"] # Display a warning message post_message -type warning "Defaulting fmax to 155.55mhz" # Display a critical warning message post_message -type critical_warning "Invalid fmax was specified - defaulting to 155.55mhz" |
|||
Return Value | Code Name | Code | String Return | |
TCL_OK | 0 | INFO: Operation successful | ||
TCL_ERROR | 1 | ERROR: Error(s) found while processing handle: <string>. Make sure you specified a valid Quartus Prime message handle for the -<string> option and passed the correct number of arguments to the -<string> option. Also check that you passed the correct message type to the -<string> option. | ||
TCL_ERROR | 1 | ERROR: Illegal message type: <string>. Specify info, warning, critical_warning, or error. | ||
TCL_ERROR | 1 | ERROR: Missing required positional argument: <string>. Specify the <string> argument. | ||
TCL_ERROR | 1 | ERROR: You specified <string> arguments to the -args option. However, you can pass a maximum of <string> arguments. |