sm_name_hdr (SMIT selector header) object class
A selector screen is specified by two objects: an sm_name_hdr object that specifies the screen title and other information, and an sm_cmd_opt object that specifies what type of data item is to be obtained.
Note: When coding an object in this object class, set unused empty strings to "" (double-quotation marks) and unused integer fields to 0.
In a SMIT Selector Header screen ( sm_name_hdr) with type = "c", if you specify a value using a : (colon), (for example, tty:0), SMIT inserts a #! (pound sign, exclamation point) in front of the : to signify that the : is not a field separator. SMIT removes the #! after parsing the rest of the value, before passing it to the cmd_to_classify descriptor. To make any further additions to the cmd_to_classify descriptor, reinsert the #! in front of the :
The descriptors for the sm_name_hdr object class are:
Descriptor | Definition |
---|---|
id | The ID or name of the object. The id field can be externalized as a fast path ID unless has_name_select is set to "y" (yes). The value of id is a string with a maximum length of 64 characters. IDs should be unique to your application and unique within your system. |
next_id | Specifies the header object for the subsequent screen; set to the value of the id field of the sm_cmd_hdr object or the sm_name_hdr object that follows this selector. The next_type field described below specifies which object class is indicated. The value of next_id is a string with a maximum length of 64 characters. |
option_id | Specifies the body of this selector; set to the id field of the sm_cmd_opt object. The value of option_id is a string with a maximum length of 64 characters. |
has_name_select | Specifies whether this screen must be preceded by a selector
screen. Valid values are:
|
name | The text displayed as the title of the selector screen. The value of name is a string with a maximum length of 1024 characters. The string can be formatted with embedded \n (newline) characters. |
name_msg_file | The file name (not the full path name) that is the Message Facility catalog for the string, name. The value of name_msg_file is a string with a maximum length of 1024 characters. Message catalogs required by an application program can be developed with the Message Facility. |
name_msg_set | The Message Facility set ID for the string, name. Set IDs can be used to indicate subsets of a single catalog. The value of name_msg_set is an integer. |
name_msg_id | The Message Facility ID for the string, name. The value of name_msg_id is an integer. |
type | The method to be used to process the selector. The value
of type is a string with a maximum length of 1 character. Valid
values are:
|
ghost | Specifies whether to display this selector screen or only
the list pop-up panel produced by the command in the cmd_to_list field.
The value of ghost is a string. Valid values are:
|
cmd_to_classify | The command string to be used, if needed, to classify the value of the name field of the sm_cmd_opt object associated with this selector. The value of cmd_to_classify is a string with a maximum length of 1024 characters. The input to the cmd_to_classify taken from the entry field is called the "raw name" and the output of the cmd_to_classify is called the "cooked name". Previous to AIX® Version 4.2.1, you could create only one value with cmd_to_classify. If that value included a colon, it was escaped automatically. In AIX 4.2.1 and later, you can create multiple values with cmd_to_classify, but the colons are no longer escaped. The colon is now being used as a delimiter by this command. If you use colons in your values, you must preserve them manually. |
cmd_to_classify_postfix | The postfix to interpret and add to the command string in the cmd_to_classify field. The value of cmd_to_classify_postfix is a string with a maximum length of 1024 characters. |
raw_field_name | The alternate name for the raw value. The value of raw_field_name is a string with a maximum length of 1024 characters. The default value is "_rawname". |
cooked_field_name | The alternate name for the cooked value. The value of cooked_field_name is a string with a maximum length of 1024 characters. The default value is "cookedname". |
next_type | The type of screen that follows this selector. Valid values
are:
|
help_msg_id | Specifies a Message Facility message set number and message ID number with a comma as the separator or a numeric string equal to a SMIT identifier tag. |
help_msg_loc | The file name sent as a parameter to the man command for retrieval of help text, or the file name of a file containing help text. The value of help_msg_loc is a string with a maximum length of 1024 characters. |
help_msg_base | The fully qualified path name of a library that SMIT reads for the file names associated with the correct book. |
help_msg_book | Contains the string with the value of the name file contained in the file library indicated by help_msg_base. |