com.esri.arcgis.system
Interface IAuthorizeLicense

All Superinterfaces:
Serializable
All Known Implementing Classes:
AoAuthorizeLicense

public interface IAuthorizeLicense
extends Serializable

Provides access to members that authorize ESRI licenses.

Description

The IAoAuthorizeLicense interface is the starting point for developers who want to silently 'authorize' the ArcGIS Engine Runtime components on client systems.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux


Method Summary
 void addLicense(String featureName, int versionNumber, String timeoutDate, String registrationNumber, String authorizationCode)
          Add a new feature to the authorization file.
 void addLicenseFromFile(String fileName)
          Add new feature authorizations from file.
 String getFeaturesAdded()
          Retrieves the details of the new features added to the authorization file.
 String getLastError()
          Retrieves the last error message from an attempt to add new features to the authorization file.
 

Method Detail

getLastError

String getLastError()
                    throws IOException,
                           AutomationException
Retrieves the last error message from an attempt to add new features to the authorization file.

Description

The LastError property returns information about why the AddLicense method failed to add the specified license to the keycodes file. Use the LastError property after the AddLicense method to retrieve information on the nature of any error.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
The lastError
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFeaturesAdded

String getFeaturesAdded()
                        throws IOException,
                               AutomationException
Retrieves the details of the new features added to the authorization file.

Description

Use the FeaturesAdded property after the AddLicenseFromFile and AddLicense methods to return a list of the license features that were successfully added to the keycodes file.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
The featuresAdded
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addLicense

void addLicense(String featureName,
                int versionNumber,
                String timeoutDate,
                String registrationNumber,
                String authorizationCode)
                throws IOException,
                       AutomationException
Add a new feature to the authorization file.

Description

The AddLicense method takes the specified license information and adds it to the keycodes file.

Use the LastError property to returns information about why the AddLicense method failed to add the specified license to the keycodes file.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
featureName - The featureName (in)
versionNumber - The versionNumber (in)
timeoutDate - The timeoutDate (in)
registrationNumber - The registrationNumber (in)
authorizationCode - The authorizationCode (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addLicenseFromFile

void addLicenseFromFile(String fileName)
                        throws IOException,
                               AutomationException
Add new feature authorizations from file.

Description

The AddLicenseFromFile method reads the authorization information in the supplied esri copy protected license file (*.ecp) and adds it to the keycodes file.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
fileName - The fileName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.