 |
This document is archived and information here might be outdated. Recommended version. |
ILicenseControl.Summary Property (ArcObjects .NET 10.5 SDK)
|
This document is archived and information here might be outdated. Recommended version. |
| ArcObjects Help for .NET developers > ArcObjects namespaces > Controls > ESRI ArcGIS Controls > Interfaces > IL > ILicenseControl Interface > ILicenseControl.Summary Property (ArcObjects .NET 10.5 SDK) |
A summary of the status of the LicenseControl initialization.
[Visual Basic .NET] Public ReadOnly Property Summary As String
[C#] public string Summary {get;}
[C++]
HRESULT get_Summary(
BSTR* Summary
);
[C++]
Parameters Summary [out, retval] Summary is a parameter of type BSTR
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."
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.