com.esri.arcgis.controls
Interface ILicenseControl

All Superinterfaces:
Serializable
All Known Implementing Classes:
ILicenseControlProxy, LicenseControl

public interface ILicenseControl
extends Serializable

Provides access to members that control the LicenseControl.

Description

The ILicenseControl interface is a starting point for determining why the LicenseControl failed to initialize an application with a product license or failed to check out an extension license.

Product Availability

Available with ArcGIS Engine.


Method Summary
 void aboutBox()
          Displays a dialog of information about the LicenseControl.
 String getLicenseAvailability(int option)
          A Description of the availability of the licenses either all licenses or just those specified in the LicenseControls property page.
 int getStatus()
          The status of the LicenseControl initialization.
 String getSummary()
          A summary of the status of the LicenseControl initialization.
 void showStatusDialog(int hWndParent, int option, Object windowTitle, Object heading)
          Shows a dialog displaying the LicenseControl status and the current license availability.
 

Method Detail

aboutBox

void aboutBox()
              throws IOException,
                     AutomationException
Displays a dialog of information about the LicenseControl.

Description

The AboutBox method causes a modal dialog box to display on top of the LicenseControl, containing information about the version and creation date of the LicenseControl as well as listing relevant legal and copyright information from ESRI.

Product Availability

Available with ArcGIS Engine.

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

getStatus

int getStatus()
              throws IOException,
                     AutomationException
The status of the LicenseControl initialization.

Description

Returns the Status of the LicenseControl when it initially tried to initilaize the application. If license initailization was successful the Status will return esriLicenseCheckedOut.

Remarks

If no product licenses were checked in the LicenseControl property pages, the Status returns esriLicenseFailure.

Product Availability

Available with ArcGIS Engine.

Returns:
A com.esri.arcgis.system.esriLicenseStatus constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSummary

String getSummary()
                  throws IOException,
                         AutomationException
A summary of the status of the LicenseControl initialization.

Description

Returns a summary of the license status after the LicenseControl has tried to initialize the application with a license. Use the Summary property when license initialization fails, to give information to the user on the nature of the failure, before programmatically shutting down the application.

The possible descriptions returned from the Summary property are as follows:
- "Successful license initialization."
- "No licenses were requested."
- "Failed to initialize license, required products are not available."
- "Failed to initialize license, required extensions are not available."
- "Failed to initialize product license."
- "Failed to checkout extension license."

Remarks

The default behaviour of the LicenseControl is to allow the developer to programmatically check for and shutdown an application when license initialization fails. To override this behaviour so the LicenseControl automatically shuts down an application when license initialization fails, check the "Shutdown this application if the selected licenses are not available" check box in the property pages of the LicenseControl.

Product Availability

Available with ArcGIS Engine.

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

getLicenseAvailability

String getLicenseAvailability(int option)
                              throws IOException,
                                     AutomationException
A Description of the availability of the licenses either all licenses or just those specified in the LicenseControls property page.

Product Availability

Available with ArcGIS Engine.

Parameters:
option - A com.esri.arcgis.controls.esriLicenseStatusOptions constant (in, optional, pass 1 if not required)
Returns:
The description
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

showStatusDialog

void showStatusDialog(int hWndParent,
                      int option,
                      Object windowTitle,
                      Object heading)
                      throws IOException,
                             AutomationException
Shows a dialog displaying the LicenseControl status and the current license availability.

Description

Opens a modal dialog specifying the current availability of the specified product and extension licenses. Use the ShowStatusDialog method when license initialization fails, to give information to the user on the nature of the failure, before programmatically shutting down the application. Alternatively, use the Status, Summary and LicenseAvailability members to create your own dialog.

esriLicenseStatusRequested returns the availability of those product and extension licenses checked in the LicenseControl property pages. Use this option when license initialization fails, to give information to the user on the nature of the failure, before programmatically shutting down the application.

esriLicenseStatusAll returns the availability of all product and extension licenses. Use this option when debugging.

By default the modal dialog will have a window title of "License Status" and a heading of "Requested License Status".

Remarks

The default behaviour of the LicenseControl is to allow the developer to programmatically check for and shutdown an application when license initialization fails. To override this behaviour so the LicenseControl automatically shuts down an application when license initialization fails, check the "Shutdown this application if the selected licenses are not available" check box in the property pages of the LicenseControl.

Product Availability

Available with ArcGIS Engine.

Parameters:
hWndParent - The hWndParent (in, optional, pass 0 if not required)
option - A com.esri.arcgis.controls.esriLicenseStatusOptions constant (in, optional, pass 1 if not required)
windowTitle - A Variant (in, optional, pass null if not required)
heading - A Variant (in, optional, pass null if not required)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.