list_info notes
Allows the user to obtain information for Notes. You may instruct Adams View to print this information to the "Info Window" or to a file or both.
Format:
list_info notes |
|---|
note_name = | an existing note name |
brief = | on/off |
write_to_terminal = | on/off |
file_name = | string specifying the file path |
Example:
list_info notes & |
|---|
note_name = | note_1 & |
brief = | on & |
write_to_terminal = | off & |
file_name = | "C:\info.txt" |
Description:
Parameter | Value Type | Description |
|---|
note_name | AN EXISTING NOTE | Specifies an existing model. |
brief | ON_OFF | Specifies whether to use the brief form (default) or an extended form of the requested information to be displayed. |
write_to_terminal | ON_OFF | Specify if the information requested is to be sent to the informational window or not. |
file_name | STRING | Specify that the information requested is to be sent to a file with the name specified with the parameter. |
Extended Definition:
1. All information for the specified note name will be displayed. This information includes note name, type, parent name, parent type, location, and the note.The note name can be entered, or a note can be picked from the screen.
2. You may identify a note by typing its name or by picking it from the screen.
If the note is not visible on the screen, you must type the name. You may also find it convenient to type the name even if the note is displayed. If a note is available by default, you may identify it by entering its name only. If it is not, you must enter its full name. To identify a note under a model, for instance, you may need to enter the model name as well. For example, you may specify note "n1" from the model named test by entering ".test.n1". You must separate multiple note names by commas. If the note is visible in one of your views, you may identify it by picking on any of the graphics associated with it. You need not separate multiple note picks by commas.
3. The ‘write_to_terminal’ parameter is most likely be used in conjunction with the FILE_NAME parameter to get the information put to a file only.
Tips:
1. If you type a "?", Adams View will list the notes available by default.