ILicenseControl.ShowStatusDialog Method

Shows a dialog displaying the LicenseControl status and the current license availability.

[Visual Basic .NET]
Public Sub ShowStatusDialog ( _
    [ByVal hWndParent As Integer], _
    [ByVal option As esriLicenseStatusOptions], _
    [ByVal windowTitle As Object], _
    [ByVal heading As Object] _
)

[C#]
public void ShowStatusDialog (
    int hWndParent,
    esriLicenseStatusOptions option,
    object windowTitle,
    object heading
);

[C++]
HRESULT ShowStatusDialog(
  long hWndParent,
  esriLicenseStatusOptions option,
  VARIANT windowTitle,
  VARIANT heading
);

[C++]
Parameters
hWndParent [in, optional, defaultvalue()]

  hWndParent is a parameter of type long
option [in, optional, defaultvalue()]

  option is a parameter of type esriLicenseStatusOptions
windowTitle [in, optional]

  windowTitle is a parameter of type VARIANT

  To indicate this parameter is undefined pass in a VARIANT with type VT_ERROR and scode value of DISP_E_PARAMNOTFOUND.
heading [in, optional]

  heading is a parameter of type VARIANT

  To indicate this parameter is undefined pass in a VARIANT with type VT_ERROR and scode value of DISP_E_PARAMNOTFOUND.

Product 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".

Errors Returned

1029 800a0405: Version incompatibility when loading from a stream, the stream version is ahead of the current software version

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