Tutorial Toolkit Function Descriptions > Obsolete, Modified, and Broken Functions > Files (Chapter 3)
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">   
Files (Chapter 3)
Modified
The documentation implies that the user needs to supply the value of the variable DIRNAME for this call, but in reality the value of DIRNAME is supposed to be returned.
Changed the variable DIRNAME to be an output argument.
Original Description Information:
(dirname )
Description:
Return the current directory.
Input:
STRING
dirname[]
Possible file directory.
Output:
INTEGER
<Return Value>
Was directory found.
Error Conditions:
None.
Remarks:
None.
Examples:
None.
New Description Information:
(dirname )
Description:
Return the current directory.
Input:
None.
Output:
STRING
dirname[]
Possible file directory.
INTEGER
<Return Value>
Was directory found.
Error Conditions:
None.
Remarks:
None.
Examples:
None.
Modified
The function is working properly; however, the documentation stated that the <Return Value> was of type logical when it should have been of type integer.
Changed the <Return Value> from type logical to type integer.
Original Description Information:
(filename)
Description:
To determine if the indicated file is currently locked.
Input:
STRING
filename[]
Name of the file to check for lock.
Output:
LOGICAL
<Return Value>
TRUE if file is locked, else FALSE.
Error Conditions:
None.
Remarks:
None.
Examples:
None.
New Description Information:
(filename)
Description:
To determine if the indicated file is currently locked.
Input:
STRING
filename[]
Name of the file to check for lock.
Output:
INTEGER
<Return Value>
0 if file is locked, else 1.
Error Conditions:
None.
Remarks:
None.
Examples:
None.
 
Broken
The routine does not work. The call does not disable the write command.
No resolution has been found for this issue.
 
Original Description Information:
(alogical)
Description:
To control whether the next “$pcl_func(blah, blah)”. Depending upon value of ‘flag’.
Input:
LOGICAL
alogical
TRUE -- don’t record next “$pcl_func()”.
FALSE -- record next “$pcl_func()”.
Output:
None.
Error Conditions:
None.
Remarks:
None.
Examples:
None.
 
Original Description Information:
(alogical)
Description:
To control whether the next “$pcl_func(blah, blah)”. Depending upon value of ‘flag’.
Input:
LOGICAL
alogical
TRUE -- don’t record next “$pcl_func()”.
FALSE -- record next “$pcl_func()”.
Output:
None.
Error Conditions:
None.
Remarks:
None.
Examples:
None.
Broken
This call generates a “.mif” file as described but the file is not an accurate representation of the form.
No resolution has been found for this issue.
 
Original Description Information:
( classname, scale )
Description:
Given the string classname as the name of a class which has a form currently displayed, this function will create a framemaker file classname.mif file which contains the form at a scale factor of scale.
Input:
STRING
classname
Name of the PCL class containing the form to be used.
REAL
scale
Scale factor for translation. Optional and defaults to 1.0.
Output:
None.
Error Conditions:
None.
Remarks:
None.
Examples:
None.
Modified
The offsets used with the output arguments patran_summary and iges_summary were changed.
Changed the values for patran_summary and iges_summary in the documentation.
 
Original Description Information:
ugi_export_iges_v1
(filnam, start_section, nlpos, nlknt, product_id, author, author_org, model_units, entity_toggle_values, all_groups, ngroups, group_ids, patran_summary, iges_summary )
Description:
Export MSC.Patran geometry to the IGES standard.
Input:
STRING
filnam[]
IGES file name to create.
STRING
start_section[]
IGES file start section prolog lines.
INTEGER
nlpos ( )
Array of nlknt values. Each entry is the # of characters for that line of the “IGES file start section prolog” plus the pervious lines.
INTEGER
nlknt
Number of lines in the “IGES file start section prolog”.
STRING
product_id[]
Product Id for receiving system.
STRING
author[]
Author.
STRING
author_org[]
Author’s Organization.
STRING
model_units[]
IGES file model units.
LOGICAL
entity_toggle_values(35)
Flags to specify which MSC.Patran entity types to export. Only the first 7 flags are used.
LOGICAL
all_groups
TRUE if all groups are to be exported.
INTEGER
ngroups
Number of groups to export.
INTEGER
group_ids ( )
Group ids to export.
Output:
INTEGER
patran_summary (7)
Number of MSC.Patran entities processed.
INTEGER
iges_summary (20)
Number of IGES entities created.
INTEGER
<Return Value>
0 if Function was successful.
Error Conditions:
None.
Remarks:
None.
Examples:
None.
 
 
 
 
New Description Information:
ugi_export_iges_v1
(filnam, start_section, nlpos, nlknt, product_id, author, author_org, model_units, entity_toggle_values, all_groups, ngroups, group_ids, patran_summary, iges_summary )
Description:
Export MSC.Patran geometry to the IGES standard.
Input:
STRING
filnam[]
IGES file name to create.
STRING
start_section[]
IGES file start section prolog lines.
INTEGER
nlpos ( )
Array of nlknt values. Each entry is the # of characters for that line of the “IGES file start section prolog” plus the pervious lines.
INTEGER
nlknt
Number of lines in the “IGES file start section prolog”.
STRING
product_id[]
Product Id for receiving system.
STRING
author[]
Author.
STRING
author_org[]
Author’s Organization.
STRING
model_units[]
IGES file model units.
LOGICAL
entity_toggle_values(35)
Flags to specify which MSC.Patran entity types to export. Only the first 7 flags are used.
LOGICAL
all_groups
TRUE if all groups are to be exported.
INTEGER
ngroups
Number of groups to export.
INTEGER
group_ids ( )
Group ids to export.
Output:
INTEGER
patran_summary (8)
Number of MSC.Patran entities processed.
INTEGER
iges_summary (21)
Number of IGES entities created.
INTEGER
<Return Value>
0 if Function was successful.
Error Conditions:
None.
Remarks:
None.
Examples:
None.