访问用户退出返回代码

Synopsis

&UEXERR

Description

Accesses the user exit return code. The return code is passed to Unigraphics when the GRIP program is finished executing. This code tells Unigraphics which interactive step to continue with after the user exit.

NOTE: You should always initially set the code to -1 in your GRIP program. Your program should then set the value to determine the next interactive step in Unigraphics after the user exit terminates.

Characteristics

Read/Write - Number - [-2..3]

ME="ovw">Overview

When the system returns from the GRIP program, if no active part exists, the main menu usually displays. See the following tables for exceptions.

NOTE: &UEXERR is only implemented for the user exits discussed in the following descriptions.

When the system returns from the GRIP program, if an active part exists, the code is interpreted as follows:

Return Code

Description

-2

User has no access to program

-1

Program error

0

Success, continue

1

Success, jump over function

2

Success, choose ok

3

Success, directory pathname returned: choose ok

The next interactive step which occurs is based on the Unigraphics function which caused the user exit as follows.

Open Part

The open part (retrieve) user exit is invoked after the File—>Open menu.

If no GRIP program error is returned and an active part exists, control is returned to the current module.

If no active part exists, the next interactive step is determined by the return code as follows:

Return Code

Description

1

Gateway Menu

2

Choose part name file selection dialog with the string (from &UESTR) as the default.

New Part

The new part user exit is invoked after the File—>New menu.

If no GRIP program error is returned and an active part exists, control is returned to the current module.

If no active part exists, the next interactive step is determined by the return code as follows:

Return Code

Description

1

Gateway Menu

2

Choose part name file selection dialog with the string (from &UESTR) as the default.

Save Part

The save part user exit occurs after the File—>Save menu.

If no GRIP program error occurs and an active part exists, the next interactive step is to continue with the last main menu (dialog 1).

Save Part As

The save part as user exit occurs after the File—>Save As... menu.

When the mode is Design in Context and the work part to save is not the displayed part, then for each level of the assembly that contains the work part, the full file specification of the current part name is passed as the string parameter (from &UESTR) to the user exit. This enables you to identify which part is to be "saved as".

If no GRIP program error occurs and an active part exists, the next interactive step is determined by the return code as follows:

Return Code

Description

1

Gateway menu. Control passes back to the Gateway menu after going through the warnings and clean up routines of the normal UG dialogs if required.

2

Choose part name file selection dialog with the string (from &UESTR) as the default. For Design in Context, control passes to the normal UG dialogs for each level of the assembly above the work part (occurrence in an assembly tree) but with a default string for the new part name as specified by the string from &UESTR.

n

File—>Save As dialog with no default string. n not equal to 1 or 2. For Design in Context, control passes to the normal UG dialogs for each level of the assembly above the work part (occurrence in an assembly tree).

Import Part

The import (merge) part user exit occurs after the File—>Import—>Part menu.

If an active part exists, the next interactive step is determined by the return code as follows:

Return Code

Description

0

Import Part dialog

2

Import Part dialog, with the default filename set

as returned from the user exit. This filename will be used when the file selection box comes up following the import part dialog.

Any other positive return code will cause the import-part operation to be aborted.

Execute GRIP

The execute GRIP user exit occurs after the File—>Execute—>GRIP menu.

The next interactive step is determined by the return code as follows:

Return Code

Description

1

Runs the GRIP program using the string passed from param. The Motif file dialog is not displayed

2

Disables the Execute GRIP option. The system adminstrator has the option of making this option (and the use of a GRIP license) unavailable.

Add Existing Part

The add existing part (retrieve component) user exit occurs after the Assemblies—>Edit Structure—>Add Existing Part menu and before the select part dialog.

If no GRIP program error is returned and no active part exists, the Select Part dialog displays.

If an active part exists, the next interactive step is determined by the return code as follows:

Return Code

Description

1

Assemblies—>Edit Structure—>Add Existing Part menu

2

Select Part dialog with the string (from &UESTR) as the default provided the part exists so that it can be loaded.

3

Component Parameters dialog with the part (from &UESTR) as the part to be added.

n

Select Part dialog with no default string. "n" is any other return code except 1, 2, or 3.

Export Part

The export part user exit occurs after the File—>Export—>Part menu and before the select part dialog.

If no GRIP program error is returned and no active part exists, the file menu displays.

If an active part exists, the next interactive step is determined by the return code as follows:

Return Code

Description

1

File—>Export menu

2

Select part dialog with the string (from &UESTR) as the default.

n

Select part dialog with no default string. "n" is any other return code except 1 or 2.

Component Where-Used

The component where-used user exit occurs after the Assemblies—>Reports—>Where Used menu and before the select components dialog.

If no GRIP program error is returned and no active part exists, the file menu displays.

If an active part exists, the next interactive step is determined by the return code as follows:

Return Code

Description

1

Gateway menu

2

Assemblies—>Reports—>Where Used dialog with the string (from &UESTR) as the default component name.

3

Assemblies—>Reports—>Where Used dialog with the string (from &UESTR) as the default directory path name.

4

Assemblies—>Reports—>Where Used dialog with the displayed part name as the default.

n

Assemblies—>Reports—>Where Used dialog with no default string. "n" is any other code except 1 - 4.

Plot File

The plot file user exit occurs at File—>Plot... menu. There is no input or output exit string.

If an active part exists, the next interactive step is determined by the return code as follows:

Return Code

Description

1

Gateway menu

n

Plot dialog. "n" is any other code except 1.

2D Analysis Using Curves

The 2D analysis using curve user exit occurs after the Info—>Analysis...—>Area Properties - Using Curves menu. This user exit bypasses the curve analysis routine and substitutes your user exit program. There are no return codes associated with this exit.

User Defined Symbols

The user defined symbols user exit occurs after the Application—>Drafting—>Create—>User Defined Symbols menu. There are no return codes for this option. If the user exit exists, your routine executes and then the User Defined Symbol dialog displays. if the user exit does not exist, the User Defined Symbol dialog displays.

CLSF Open

The CLSF open user exit occurs after the Application—>Manufacturing...ToolBox—>CLSF menu.

If an active part exists, the next interactive step is determined by the return code as follows:

Return Code

Description

1

Displays the Select File dialog with the default string ( part filename with a ".clf" file extension).

2

Successful. Open CLSF specified by string from &UESTR. The Select File dialog does not display.

CLSF Save

The CLSF save exit is activated by any of the following actions:

File—>Save—>CLSF
File—>Save—>CLSF As You use this exit in succession with the USER_CLS_RENAME exit.
Tool Path Acceptance: Preferences—>Autofile CLSF, Toolbox—>Operation—>Generate—>OK

You can pass the CLSF name through the &UESTR GPA.

If no GRIP program error is returned and no active part exists, the File Main menu displays.

If an active part exists, the next interactive step is determined by the return code as follows:

Return Code

Description

0

Indicates success. The CLSF was saved.

1

User Exit error. The CLSF was not saved.

CLSF Rename

The rename CLSF exit occurs after Application—>Manufacturing—>File—>Save—>CLSF As. Selecting this option executes both the USER_CLS_RENAME and USER_CLS_SAVE exits in succession.

You can pass the CLSF name through the &UESTR GPA.

If no GRIP program error is returned and no active part exists, the File Main menu displays.

If an active part exists, the next interactive step is determined by the return code as follows:

Return Code

Description

1

Displays the File Selection dialog. Saves the CLSF when the user selects the OK button.

2

Indicates success. Saves the CLSF using the string from &UESTR as the new name.

Generate CLF

The generate CLF exit occurs after Application—>Manufacturing—>Toolbox—>CLSF—>Postprocess—> Generate CLF. Selecting this option executes both the USER_CL_GEN (CLF generation) exit.

You can pass the CLF name through the &UESTR GPA.

If no GRIP program error is returned and no active part exists, the File Main menu displays.

If an active part exists, the next interactive step is determined by the return code as follows:

Return Code

Description

-1

User Exit Error

0

User Exit does not exist.

1

Successful User Exit execution

Postprocess CLSF

The postprocess CLF exit occurs after Application—>Manufacturing—>Toolbox—>CLSF—>Postprocess->Postprocess. Selecting this option executes both the USER_CL_GEN (CLF generation) and USER_POST (CLSF postprocessing) exits in succession.

You can pass the CLF name through the &UESTR GPA.

If no GRIP program error is returned and no active part exists, the File Main menu displays.

If an active part exists, the next interactive step is determined by the return code as follows:

Return Code

Description

-1

User Exit Error

0

User Exit does not exist.

1

Successful User Exit execution

Access Genius System

This exit accesses the Genius Library Management System. Genius is an external EDS product used by the Manufacturing Module for Tool Data Management. The Genius exit occurs after Application—>Manufacturing—>Toolbox—>Tool—>Genius. There are no return codes associated with this exit.

Create Component

The create component user exit occurs after the Assemblies—>Edit Structure—>Create New Component—>Add Object Methods menu and before the select part dialog.

If no GRIP program error is returned and no active part exists, the Select Part dialog displays.

If an active part exists, the next interactive step is determined by the return code as follows:

Return Code

Description

1

Assemblies—>Edit Structure—>Add Existing Part menu

2

Select Part dialog with the string (from &UESTR) as the default.

n

Select Part dialog with no default string. "n" is any other return code except 1 or 2.

Change Displayed Part

The change displayed part user exit occurs after the File—>Change Displayed Part menu and before the select part dialog.

If no GRIP program error is returned and no active part exists, the Select Part dialog displays.

If an active part exists, the next interactive step is determined by the return code as follows:

Return Code

Description

1

Continue with last main menu (dialog area 1).

2

Select Part dialog with the string (from &UESTR) as the default.

n

Select Part dialog with no default string. "n" is any other return code except 1 or 2.

Change Work Part

The change work part user exit occurs after the Assemblies—>Change Work Part... menu and before the select part dialog.

If no GRIP program error is returned and no active part exists, the Select Part dialog displays.

If an active part exists, the next interactive step is determined by the return code as follows:

Return Code

Description

1

Continue with last main menu (dialog area 1).

2

Select Part dialog with the string (from &UESTR) as the default.

n

Continue with last main menu (dialog area 1). "n" is any other return code except 1 or 2.

Remove Component

The remove component user exit occurs after the Assemblies—>Edit Structure—>Remove Component menu and before the select components dialog.

If no GRIP program error is returned and no active part exists, the Select Part dialog displays.

If an active part exists, the next interactive step is determined by the return code as follows:

Return Code

Description

1

Assemblies—>Edit Structure—>Remove Component menu

2

Select Components dialog with the string (from &UESTR) as the default.

n

Select Components dialog with no default string. "n" is any other return code except 1 or 2.

Reposition Component

The reposition component user exit occurs after the Assemblies—>Edit Structure—>Reposition Component menu and before the select components dialog.

If no GRIP program error is returned and no active part exists, the Select Part dialog displays.

If an active part exists, the next interactive step is determined by the return code as follows:

Return Code

Description

1

Assemblies—>Edit Structure—>Reposition Component menu

2

Select Components dialog with the string (from &UESTR) as the default.

n

Select Components dialog with no default string. "n" is any other return code except 1 or 2.

Substitute Component Out

The substitute component out user exit occurs after the Assemblies—>Edit Structure—>Substitute Component menu and before the select components dialog.

The next interactive step is determined by the return code as follows:

Return Code

Description

1

Assemblies—>Edit Structure—>Substitute Component menu

2

Select Components dialog with the string (from &UESTR) as the default.

n

Select Components dialog with no default string. "n" is any other return code except 1 or 2.

Substitute Component In

The substitute component in user exit occurs after the Assemblies—>Edit Structure—>Substitute Component—>Choose Component menu and before the select components dialog.

The next interactive step is determined by the return code as follows:

Return Code

Description

1

Assemblies—>Edit Structure—>Substitute Component—>Choose Component menu

2

Select Components dialog with the string (from &UESTR) as the default.

3

Substitute component parameters menu with the part (from &UESTR).

n

Select Components dialog with no default string. "n" is any other return code except 1, 2, or 3.

Replace Reference Set

The replace reference set user exit occurs after the Assemblies—>Edit Structure—>Replace Reference Set menu and before the select components dialog.

The next interactive step is determined by the return code as follows:

Return Code

Description

1

Assemblies—>Edit Structure—>Rename Component menu

2

Select Components dialog with the string (from &UESTR) as the default.

n

Select Components dialog with no default string. "n" is any other return code except 1 or 2.

Rename Component

The rename component user exit occurs after the Assemblies—>Edit Structure—>Rename Component menu and before the select components dialog.

The next interactive step is determined by the return code as follows:

UG Startup

The UG startup user exit occurs when you invoke Unigraphics. There are no return codes for this option. If the user exit exists, your routine executes. if the user exit does not exist, then UG starts as it normally would.

Debug GRIP

The execute Debug GRIP user exit occurs after the File—>Execute—>Debug GRIP menu.

The next interactive step is determined by the return code as follows:

Return Code

Description

1

Runs the Debug GRIP program using the string passed from param. The Motif file dialog is not displayed.

2

Disables the Execute Debug GRIP option. The system adminstrator has the option of making this option (and the use of a GRIP license) unavailable.

User Function

The execute User Function user exit occurs after the File—>Execute—>User Function menu.

The next interactive step is determined by the return code as follows:

Return Code

Description

1

Runs the User Function program using the string passed from param. The Motif file dialog is not displayed.

2

Disables the Execute User Function option. The system adminstrator has the option of making this option (and the use of a User Function license) unavailable.

Open Spreadsheet

The open spreadsheet user exit occurs after a spreadsheet executable is started, and before any spreadsheets are loaded. You must be in the modeling application. This event occurs after you select Toolbox—>Spreadsheet. Return codes are ignored with this exit.

NOTE: Both the open and close spreadsheet exits are only available to customers who have purchased a full license for the Xess spreadsheet.

Close Spreadsheet

The close spreadsheet user exit occurs when you exit the spreadsheet and return control to Unigraphics. Choose the Modeling application. This event occurs interactively when a spreadsheet is active by selecting either File—>Exit or Connect—>Disconnect from the spreadsheet menu bar. Return codes are ignored with this exit.

Update Spreadsheet

The update spreadsheet exit occurs at the start of updating expressions into the UG part file. You must be in the modeling application. First, you need to call Tools—>Extract Expr in order to have some expressions. The interactive entry point is Tools—>Update UG Part.

Finish Updating Spreadsheet

The finish updating spreadsheet exit occurs at the completion of updating expressions. You must be in the modeling application.

CAM New Operation

The CAM new operation exit occurs after Application—>Manufacturing in two places:

Select the desired Operation Template Type and Subtype. Press the NEW button.
Select existing operation(s) to be reinitialized. Press the REINIT button.

You pass the name of the operation through the oper_name argument. If you select more than one operation for reinitialization, then the exit is called once for each operation that is to be reinitialized.

The next interactive step is determined by the return code as follows:

Return Code

Description

-1

User Exit error, abort operation action and return to CAM Operation Manager dialog.

0

Successful User Exit execution, proceed normally.

1

Successful User Exit execution, return to CAM Operation Manager dialog.

CAM Startup

The CAM startup user exit occurs after the Application—>Manufacturing... menu

The next interactive step is determined by the return code as follows:

Return Code

Description

-1

User Exit error, abort and return to Gateway.

0

Successful User Exit execution, proceed normally.

Return Code	Description
-2	User has no access to program
-1	Program error
0	Success, continue
1	Success, jump over function
2	Success, choose ok
3	Success, directory pathname returned: choose ok

Return Code	Description
1	Gateway Menu
2	Choose part name file selection dialog with the string (from &UESTR) as the default.

Return Code	Description
1	Gateway menu. Control passes back to the Gateway menu after going through the warnings and clean up routines of the normal UG dialogs if required.
2	Choose part name file selection dialog with the string (from &UESTR) as the default. For Design in Context, control passes to the normal UG dialogs for each level of the assembly above the work part (occurrence in an assembly tree) but with a default string for the new part name as specified by the string from &UESTR.
n	File—>Save As dialog with no default string. n not equal to 1 or 2. For Design in Context, control passes to the normal UG dialogs for each level of the assembly above the work part (occurrence in an assembly tree).

Return Code	Description
1	Runs the GRIP program using the string passed from param. The Motif file dialog is not displayed
2	Disables the Execute GRIP option. The system adminstrator has the option of making this option (and the use of a GRIP license) unavailable.

Return Code	Description
1	Assemblies—>Edit Structure—>Add Existing Part menu
2	Select Part dialog with the string (from &UESTR) as the default provided the part exists so that it can be loaded.
3	Component Parameters dialog with the part (from &UESTR) as the part to be added.
n	Select Part dialog with no default string. "n" is any other return code except 1, 2, or 3.

Return Code	Description
1	File—>Export menu
2	Select part dialog with the string (from &UESTR) as the default.
n	Select part dialog with no default string. "n" is any other return code except 1 or 2.

Return Code	Description
1	Displays the Select File dialog with the default string ( part filename with a ".clf" file extension).
2	Successful. Open CLSF specified by string from &UESTR. The Select File dialog does not display.

Return Code	Description
0	Indicates success. The CLSF was saved.
1	User Exit error. The CLSF was not saved.

Return Code	Description
1	Displays the File Selection dialog. Saves the CLSF when the user selects the OK button.
2	Indicates success. Saves the CLSF using the string from &UESTR as the new name.

Return Code	Description
-1	User Exit Error
0	User Exit does not exist.
1	Successful User Exit execution

Return Code	Description
1	Continue with last main menu (dialog area 1).
2	Select Part dialog with the string (from &UESTR) as the default.
n	Select Part dialog with no default string. "n" is any other return code except 1 or 2.

Return Code	Description
1	Assemblies—>Edit Structure—>Remove Component menu
2	Select Components dialog with the string (from &UESTR) as the default.
n	Select Components dialog with no default string. "n" is any other return code except 1 or 2.

Return Code	Description
1	Assemblies—>Edit Structure—>Reposition Component menu
2	Select Components dialog with the string (from &UESTR) as the default.
n	Select Components dialog with no default string. "n" is any other return code except 1 or 2.

Return Code	Description
1	Assemblies—>Edit Structure—>Substitute Component menu
2	Select Components dialog with the string (from &UESTR) as the default.
n	Select Components dialog with no default string. "n" is any other return code except 1 or 2.

Return Code	Description
1	Assemblies—>Edit Structure—>Rename Component menu
2	Select Components dialog with the string (from &UESTR) as the default.
n	Select Components dialog with no default string. "n" is any other return code except 1 or 2.

Return Code	Description
1	Runs the Debug GRIP program using the string passed from param. The Motif file dialog is not displayed.
2	Disables the Execute Debug GRIP option. The system adminstrator has the option of making this option (and the use of a GRIP license) unavailable.

Return Code	Description
1	Runs the User Function program using the string passed from param. The Motif file dialog is not displayed.
2	Disables the Execute User Function option. The system adminstrator has the option of making this option (and the use of a User Function license) unavailable.

Return Code	Description
-1	User Exit error, abort operation action and return to CAM Operation Manager dialog.
0	Successful User Exit execution, proceed normally.
1	Successful User Exit execution, return to CAM Operation Manager dialog.

Return Code	Description
-1	User Exit error, abort and return to Gateway.
0	Successful User Exit execution, proceed normally.