ILicenseControlDefault.LicenseAvailability Property

A Description of the availability of the licenses either all licenses or just those specified in the LicenseControls property page.

[Visual Basic .NET]
Public Function get_LicenseAvailability ( _
    [ByVal option As esriLicenseStatusOptions] _
) As String

[C#]
public string get_LicenseAvailability (
    esriLicenseStatusOptions option
);

[C++]
HRESULT get_LicenseAvailability(
  esriLicenseStatusOptions option,
  BSTR* Description
);

[C++]

Parameters
option [in, optional, defaultvalue(1)]

  option is a parameter of type esriLicenseStatusOptions
Description [out, retval]
  Description is a parameter of type BSTR

Product Availability

Description

Returns a string specifying the current availability of the specified product and extension licenses. The string that is returned is formatted with carriage returns and line feeds. Use the LicenseAvailability property when license initialization fails, to give information to the user on the nature of the failure, before programmatically shutting down the application.

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.

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.

See Also