Tutorial Toolkit Function Descriptions > Obsolete, Modified, and Broken Functions > User Interface (Chapter 5)
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">   
User Interface (Chapter 5)
 
Modified
The INTS, REALS, and CHARS input variables have a specified type of VARIABLE, which is not a valid PCL data type.
Changed the data type descriptions so that the variable INTS is of type INTEGER, the variable REALS is of type REAL, and the variable CHARS is of type STRING
Original Description Information:
msg_format_string
(msgcode, ints, reals, chars, string )
Description:
PCL interface to Message Utility for getting message into string(s).
Input:
INTEGER
msgcode
Message code to look up.
VARIABLE
ints
Integer array for formatting (address).
VARIABLE
reals
Real array for formatting (address).
VARIABLE
chars
Character array start for formatting (address).
Output:
STRING
string
String containing the resulting message.
INTEGER
<Return Value>
Return status of operation.
Error Conditions:
None.
Remarks:
None.
Examples:
None.
New Description Information:
msg_format_string
(msgcode, ints, reals, chars, string )
Description:
PCL interface to Message Utility for getting message into string(s).
Input:
INTEGER
msgcode
Message code to look up.
INTEGER
ints()
Integer array for formatting (address).
REAL
reals()
Real array for formatting (address).
STRING
chars[]
Character array start for formatting (address).
Output:
STRING
string[]
String containing the resulting message.
INTEGER
<Return Value>
Return status of operation.
Error Conditions:
None.
Remarks:
None.
Examples:
None.
Modified
1) Function causes core dumps. 2) The INTS, REALS, and CHARS input variables have a specified type of VARIABLE, which is not a valid PCL data type.
Changed the data type descriptions so that the variable INTS is of type INTEGER, the variable REALS is of type REAL, and the variable CHARS is of type STRING
Original Description Information:
(msgcode, msgtype, appcode, ints, reals, chars, lenchr, maxout, unit )
Description:
Output a message to a PCL fio unit.
Input:
INTEGER
msgcode
Message code to look up.
INTEGER
msgtype
Message type.
INTEGER
appcode
Application code for calling application.
VARIABLE
ints
Integer array for formatting.
VARIABLE
reals
Real array for formatting.
VARIABLE
chars
Character array (Fortran style) for formatting.
INTEGER
lenchr
Length of each element in the input arrays.
INTEGER
maxout
Maximum output size in string.
INTEGER
unit
Channel from TEXT_OPEN call.
Output:
INTEGER
<Return Value>
Number of characters left.
Error Conditions:
None.
Remarks:
None.
Examples:
None.
New Description Information:
(msgcode, msgtype, appcode, ints, reals, chars, lenchr, maxout, unit )
Description:
Output a message to a PCL fio unit.
Input:
INTEGER
msgcode
Message code to look up.
INTEGER
msgtype
Message type.
INTEGER
appcode
Application code for calling application.
INTEGER
ints()
Integer array for formatting.
REAL
reals()
Real array for formatting.
STRING
chars[]
Character array (Fortran style) for formatting.
INTEGER
lenchr
Length of each element in the input arrays.
INTEGER
maxout
Maximum output size in string.
INTEGER
unit
Channel from TEXT_OPEN call.
Output:
INTEGER
<Return Value>
Number of characters left.
Error Conditions:
None.
Remarks:
None.
Examples:
None.
Broken
Function is listed in two different manuals (97 and 208 PCL).
No Resolution has been found for this issue.
Original Description Information:
(handle )
Description:
Free memory allocated for parsing of a Picklist.
Input:
INTEGER
handle
Handle returned from lp_eval.
Output:
None.
Error Conditions:
None.
Remarks:
None.
Examples:
None.
 
 
Broken
1) Function is listed in two different manuals (98 and 217 PCL).
2) The routine does not work for many of the available options.
No Resolution has been found for this issue.
 
 
 
 
Original Description Information:
(keyword, family, text )
Description:
A layered call to LpKEYWORD_OUT. Useful for calling by FORTRAN and PCL.
Input:
INTEGER
keyword
Identifies the entity. From lpkeywords.i.
INTEGER
family
Identifies the group of entities keyword calls. From lpkeywords.i
Output:
STRING
text[]
String alias for keyword t
INTEGER
<Return Value>
See error conditions.
Error Conditions:
14000200->LpKEYWORD_TEXT:Bad arguments specified.
Remarks:
None.
Examples:
None.
 
ui_flush
Obsolete
The function represents code that should not be documented.
Removed the call from the documentation.
 
Description:
Flush the output buffer.
Input:
None.
Output:
None.
Examples:
CLASSWIDE INTEGER button_pressed
 FUNCTION driver
   ui_flush()        /* force modal form to be displayed before waiting */
   em_wait()
   RETURN( button_pressed )
 END FUNCTION   /* driver */
 
 
ui_flush_events
Obsolete
The function represents code that should not be documented.
Removed the call from the documentation.
Description:
Check the input system of the device for any unprocessed events. This should allow any window manager time to process events and other activities it is responsible for.
Input:
None.
Output:
None.
Comments:
This routine was written for X-windows, but can be easily modified to work with any other windowing system or terminal.
Example:
 FUNCTION initlz( message )
  STRING message[]
  STATIC LOGICAL init = TRUE
   IF( init ) THEN
     uil_pcntcomplete.init()
     init = FALSE
   END IF
   ui_wid_set( counter, “VALUE”, 0. )
   uil_pcntcomplete.display( message )
   ui_flush_events()
 END FUNCTION   /* initlz */
 
 
Broken
This function when run will shut down MSC.Patran. Also an Inadequate function description is given.
No resolution has been found for this issue.
Original Description Information:
( )
Description:
Return out of the event loop.
Input:
None.
Output:
None.
Error Conditions:
None.
Remarks:
None.
Examples:
None.
 
Broken
Seems to cause core dumps.
 
No resolution has been found for this issue.
Original Description Information:
( textwid, left, right, vstr )
Description:
Return selected text and it’s left and right positions in the string in which it resides.
Input:
widget
textwid
Pointer to the widget.
Output:
INTEGER
left
Left position.
INTEGER
right
Right position.
STRING
vstr[]
Selected Text.
Error Conditions:
None.
Remarks:
None.
Examples:
None.
 
ui_window_create
Obsolete
The call no longer exists.
 
Removed the call from the documentation.
Description:
Create a window widget.
Input:
STRING
name[]
Name of the widget.
REAL
x
X location of widget
REAL
y
Y location of widget
STRING
posit[]
Code indicating how the window is positioned.
REAL
width
Width of widget.
REAL
height
Height of widget.
STRING
label[]
Label to appear in namestripe.
STRING
icon[]
Name of icon.
Output:
widget
<Return Value>
Pointer to the new widget.
Error Conditions:
None.
Remarks:
None.
Examples:
None.
ui_helpmenu_create
 
Obsolete
1) Makes use of a widget created through the use of two undocumented PCL functions, ui_c_menubar and ui_c_mainwindow. 2) No apparent way to delete results from the display screen.
Removed the call from the documentation.
Description:
Create a help menu widget.
Input:
widget
parent
Pointer to the parent widget.
STRING
name[]
Name of the widget.
STRING
label[]
Label displayed in menubar.
Output:
widget
<Return Value>
Pointer to the new widget.
Error Conditions:
None.
Remarks:
None.
Example:
CLASSWIDE WIDGET menu_id
WIDGET   bar_id
 
/* Create a pulldown menu */
 
menu_id = ui_helpmenu_create( bar_id, “menu”, “Help” )
ui_wid_set( menu_id, “MNEMONIC”, “H” )
uil_primary_help.enable_entire_menu( FALSE )
End of file.
 
ui_abortwidget_create
Obsolete
This PCL function does not exist as part of the MSC.Patran executable.
Removed the call from the documentation.
Description:
Create an abort widget.
Input:
widget
parent
Pointer to the parent widget.
REAL
x
X location of widget.
REAL
y
Y location of widget.
STRING
icon[]
Name of the file containing the icon data.
STRING
icon2[]
Name of the file containing the icon2 data.
Output:
INTEGER
<Return Value>
Pointer to the new widget.
Error Conditions:
None.
Remarks:
None.
Example:
			#include “appforms.p”

			CLASSWIDE WIDGET win_id, abort_button
REAL     x_loc, y_loc, main_menu_margin
	/*  Add the abort button. */
x_loc -= main_menu_margin + 2 * MAIN_MENU_ICON_WID
 
abort_button = ui_abortwidget_create(         @
	win_id, x_loc, y_loc,       @
	“abort.up”, “abort.down” )
Broken
1) Missing the ui_wid_restore_widget call in the original MSC.Acumen documentation. 2) This function always returns FALSE.
1) Added this call to the documentation. 2) No resolution has been found for this issue.
Original Description Information:
( wid )
Description:
Restore the values for this widget and all child widgets.
Input:
widget
wid
Widget ID.
Output:
LOGICAL
<Return Value>
TRUE if no error.
Error Conditions:
None.
Remarks:
None.
Examples:
None.
 
Broken
This function always returns FALSE.
 
No resolution has been found for this issue.
 
Original Description Information:
( wid )
Description:
Save the values for this widget and all child widgets.
Input:
widget
wid
Widget ID.
Output:
LOGICAL
<Return Value>
TRUE if no error.
Error Conditions:
None.
Remarks:
None.
Examples:
None.
 
 
 
 
uil_primary_file.enable_entire_menu
Obsolete
 
Original Description Information:
uil_primary_file.enable_entire_menu
( flag )
Description:
Allows the “File” option menu on the main form to be enabled or disabled.
Input:
LOGICAL
flag
True- enables File. False- disables File.
Output:
none
 
 
uil_primary_file.enable_item
Obsolete
 
Original Description Information:
uil_primary_file.enable_item
( label, flag )
Description:
Allows the items in the “File” pull-down menu to be enabled or disabled.
Input:
STRING
label[]
Exact title found in the “File” pull down menu.
LOGICAL
flag
True-enables item. False-disables item.
Output:
none
 
 
uil_primary_pref.enable_item
Obsolete
 
 
Original Description Information:
uil_primary_pref.enable_item
( label, flag )
Description:
Enables or disables an item in the preferences menu.
Input:
STRING
label[]
STRING label of the item.
LOGICAL
flag
True- enables File. False- disables File.
Output:
none
 
 
 
Modified
Inappropriate function description.
Updated the function listing in the body of the document.
 
Original Description Information:
uil_utils_listbox.select_list
(lbox_id, labellist, listcnt)
Description:
Clear all highlighted names in the listbox.
Input:
widget
lbox_id
ID of listbox to modify.
STRING
labellist[]()
List of names in listbox to highlight.
INTEGER
listcnt
Number of items in labellist.
Output:
LOGICAL
<Return Value>
TRUE if no error.
Error Conditions:
None.
Remarks:
None.
Example:
None.
 
 
 
 
 
 
New Description Information:
uil_utils_listbox.select_list
(list_box_id, label_list, list_count)
Description:
This function will select or highlight a list of names in a listbox.
Input:
widget
list_box_id
This value specifies the identifier of the listbox.
STRING
label_list[31](list_count)
This value specifies the list of labels in the listbox that will be highlighted. These labels are defined when the listbox is created and are typically a maximum of 31 characters long.
INTEGER
list_count
This value specifies the number of labels specified by the input value label_list.
Output:
LOGICAL
<Return Value>
This function will return a value of TRUE if an error has not occurred and a value of FALSE if an error has occurred.
Error Conditions:
None.
Remarks:
None.
Example:
None.
 
Modified
When a <Return Value> is used with this call, MSC.Patran outputs the error message “invalid assignment convention, Extra information.”
Removed the <Return Value> variable from the documented description.
  
Original Description Information:
uil_utils_listbox.create_list
( lbox_id, labellist, listcnt )
Description:
Create a list of items in the listbox from the given names.
Input:
widget
lbox_id
ID of listbox to modify.
STRING
labellist[]()
List of names in listbox to create.
INTEGER
listcnt
Number of items in labellist.
Output:
LOGICAL
<Return Value>
TRUE if no error.
Error Conditions:
None.
Remarks:
None.
Examples:
None.
New Description Information:
uil_utils_listbox.create_list
( lbox_id, labellist, listcnt )
Description:
Create a list of items in the listbox from the given names.
Input:
widget
lbox_id
ID of listbox to modify.
STRING
labellist[]()
List of names in listbox to highlight.
INTEGER
listcnt
Number of items in labellist.
Output:
None.
Error Conditions:
None.
Remarks:
None.
Examples:
None.
Modified
When a <Return Value> is used with this call, MSC.Patran outputs the error message “invalid assignment convention, Extra information.”
Removed the <Return Value> variable from the documented description.
Original Description Information:
( lbox_id, labellist, listcnt )
Description:
Append a list of items in the listbox from the given names.
Input:
widget
lbox_id
ID of listbox to modify.
STRING
labellist[]()
List of name items to append.
INTEGER
listcnt
Number of items in labellist.
Output:
LOGICAL
<Return Value>
TRUE if no error.
Error Conditions:
None.
Remarks:
None.
Examples:
None.
 
 
 
New Description Information:
( lbox_id, labellist, listcnt )
Description:
Append a list of items in the listbox from the given names.
Input:
widget
lbox_id
ID of listbox to modify.
STRING
labellist[]()
List of name items to append.
INTEGER
listcnt
Number of items in labellist.
Output:
None.
Error Conditions:
None.
Remarks:
None.
Examples:
None.
uil_utils_listbox.select_one
Obsolete
Function no longer is part of the executable. It has been replaced by the uil_utils_listbox.select function.
Removed the call from the documentation.
 
Original Description Information:
uil_utils_listbox.select
( lbox_id, labellist, listcnt )
Description:
Highlight only “name” in the listbox.
Input:
widget
lbox_id
ID of listbox to modify.
STRING
name[]
Name in listbox to highlight.
Output:
None.
Error Conditions:
None.
Remarks:
Any other items that may have been highlighted are unhighlighted and only the given name is highlighted.
Examples:
None.
 
 
New
None.
 
None.