Register API Commands Tool

This tool helps to register an API command (.NET COM / Plugin / C++ COM command).

The tool can be invokedinvoked (for more on this this, click Access at the top of this Help topic) by running it from the Cimatron installation Program folder or by using a command line.

When invoked, the Register API Commands dialog is displayed:

These fields are mandatory (highlighted in red):

Select API Command DLL name.

Project Name of the command.

Class Name of the command.

This field is optional:

ICON ID file name.

The X at the end of the Select ICON for the Command field represents the icon that will be used if no icon is selected.

When you select the command DLL file, the following are displayed, as shown in the image below:

A list showing all the public classes that the project includes.

The .NET framework version that it was built with.

Selecting the Command class in the list will show the Project/Class name and also will calculate the ID of the ICON, as shown below.

Pressing the Register API Command button will register the command automatically and will update all needed data files in Cimatron.

If no ICON was selected then the default icon will be shown.

If an ICON was selected then it will be copied to the relevant DATA folder with the calculated ID.

Command Line Options

The command should be deployed by running the command line from the installation set.

When invokinginvoking (for more on this this, click Access at the top of this Help topic) from the command line, the tool receives the three mandatory parameters and the one optional parameter:

DLL full path name.

Project name.

Class name.

(Optional):

ICON full path name (if no icon is entered, the command will get the default Cimatronicon).

-U; this option uninstalls the command.

Example:

<Cimatron>\Program\Register_API_Commands.exe "<Cimatron program folder>\MyCommand.dll" MyProjectName MyClassName "<icon- path>\myIcon.ico"