ArcObjects Library Reference

Check Out Extension License Snippet

Check out a specific ArcGIS extension license for a paticular licensed product.

[C#]

///<summary>Check out a specific ArcGIS extension license for a paticular licensed product.</summary>
///  
///<param name="licenseProductCode"> An ESRI.ArcGIS.esriSystem.esriLicenseProductCode enumeration that is the level of functionality to check out for a specific ArcGIS Extension. Example: ESRI.ArcGIS.esriSystem.esriLicenseProductCode.esriLicenseProductCodeArcView</param>
///<param name="licenseExtensionCode">An ESRI.ArcGIS.esriSystem.esriLicenseExtensionCode enumeration that is the ArcGIS extension to check out. Example: ESRI.ArcGIS.esriSystem.esriLicenseExtensionCode.esriLicenseExtensionCodeSpatialAnalyst</param>
///   
///<returns>An esriLicenseStatus enumeration that details the state of the extension license. Example: ESRI.ArcGIS.esriSystem.esriLicenseStatus.esriLicenseAvailable</returns>
///   
///<remarks></remarks>
public ESRI.ArcGIS.esriSystem.esriLicenseStatus CheckOutExtensionLicense(ESRI.ArcGIS.esriSystem.esriLicenseProductCode licenseProductCode, ESRI.ArcGIS.esriSystem.esriLicenseExtensionCode licenseExtensionCode) 
{ 
  ESRI.ArcGIS.esriSystem.IAoInitialize aoInitialize=new ESRI.ArcGIS.esriSystem.AoInitializeClass(); 
  ESRI.ArcGIS.esriSystem.esriLicenseStatus licenseStatus=aoInitialize.IsExtensionCodeAvailable(licenseProductCode, licenseExtensionCode); 

  if (licenseStatus == ESRI.ArcGIS.esriSystem.esriLicenseStatus.esriLicenseAvailable) 
  { 
    licenseStatus=aoInitialize.Initialize(licenseProductCode); 
  } 
 
  if (licenseStatus == ESRI.ArcGIS.esriSystem.esriLicenseStatus.esriLicenseCheckedOut) 
  { 
    licenseStatus=aoInitialize.CheckOutExtension(licenseExtensionCode); 
  } 

  return licenseStatus; 
}

[Visual Basic .NET]

'''<summary>Check out a specific ArcGIS extension license for a paticular licensed product.</summary>
'''  
'''<param name="licenseProductCode"> An ESRI.ArcGIS.esriSystem.esriLicenseProductCode enumeration that is the level of functionality to check out for a specific ArcGIS Extension. Example: ESRI.ArcGIS.esriSystem.esriLicenseProductCode.esriLicenseProductCodeArcView</param>
'''<param name="licenseExtensionCode">An ESRI.ArcGIS.esriSystem.esriLicenseExtensionCode enumeration that is the ArcGIS extension to check out. Example: ESRI.ArcGIS.esriSystem.esriLicenseExtensionCode.esriLicenseExtensionCodeSpatialAnalyst</param>
'''   
'''<returns>An esriLicenseStatus enumeration that details the state of the extension license. Example: ESRI.ArcGIS.esriSystem.esriLicenseStatus.esriLicenseAvailable</returns>
'''   
'''<remarks></remarks>
Public Function CheckOutExtensionLicense(ByVal licenseProductCode As ESRI.ArcGIS.esriSystem.esriLicenseProductCode, ByVal licenseExtensionCode As ESRI.ArcGIS.esriSystem.esriLicenseExtensionCode) As ESRI.ArcGIS.esriSystem.esriLicenseStatus

  Dim aoInitialize As ESRI.ArcGIS.esriSystem.IAoInitialize=New ESRI.ArcGIS.esriSystem.AoInitializeClass
  Dim licenseStatus As ESRI.ArcGIS.esriSystem.esriLicenseStatus=aoInitialize.IsExtensionCodeAvailable(licenseProductCode, licenseExtensionCode)

  If licenseStatus=ESRI.ArcGIS.esriSystem.esriLicenseStatus.esriLicenseAvailable Then

    licenseStatus=aoInitialize.Initialize(licenseProductCode)

  End If

  If licenseStatus=ESRI.ArcGIS.esriSystem.esriLicenseStatus.esriLicenseCheckedOut Then

    licenseStatus=aoInitialize.CheckOutExtension(licenseExtensionCode)

  End If

  Return licenseStatus

End Function

Additional Requirements

The code in this document requires the following References added to the Visual Studio project:
ESRI.ArcGIS.System