CheckExtension

Summary

Checks to see if a license is available to be checked out for a specific type of extension.

Learn more about licensing and extensions

Syntax

CheckExtension (extension_code)
ParameterExplanationData Type
extension_code

Keyword for the extension product that is being checked.

  • 3DArcGIS 3D Analyst extension
  • AeronauticalArcGIS Aviation Charting
  • AirportsArcGIS Aviation Airports
  • ArcScanArcScan
  • BathymetryArcGIS Bathymetry
  • BusinessPremArcGIS Business Analyst
  • DataReviewerArcGIS Data Reviewer Desktop
  • DataInteroperabilityArcGIS Data Interoperability extension for Desktop
  • DefenseArcGIS Defense Mapping
  • FoundationArcGIS Production Mapping
  • GeoStatsArcGIS Geostatistical Analyst extension
  • IndoorsArcGIS Indoors
  • ImageAnalystImage Analyst
  • JTXArcGIS Workflow Manager (Classic) Desktop
  • LocationReferencingArcGIS Pipeline Referencing or ArcGIS Roads and Highways
  • LocateXTLocateXT
  • NauticalArcGIS Maritime
  • NetworkArcGIS Network Analyst extension
  • PublisherArcGIS Publisher
  • SchematicsArcGIS Schematics extension
  • SMPAsiaPacificStreetMap Premium Asia Pacific
  • SMPEuropeStreetMap Premium Europe
  • SMPJapanStreetMap Premium Japan
  • SMPLatinAmericaStreetMap Premium Latin America
  • SMPMiddleEastAfricaStreetMap Premium Middle East Africa
  • SMPNorthAmericaStreetMap Premium North America
  • SpatialArcGIS Spatial Analyst extension
  • TrackingArcGIS Tracking Analyst extension
String
Return Value
Data TypeExplanation
String

There are four possible returned values for CheckExtension:

  • AvailableThe requested license is available to be set.
  • UnavailableThe requested license is unavailable to be set.
  • NotLicensedThe requested license is not valid.
  • FailedA system failure occurred during request.

Code sample

CheckExtension example

Check for availability of ArcGIS 3D Analyst extension before checking it out.

import arcpy

class LicenseError(Exception):
    pass

try:
    if arcpy.CheckExtension("3D") == "Available":
        arcpy.CheckOutExtension("3D")
    else:
        # raise a custom exception
        raise LicenseError

    arcpy.env.workspace = "c:/GrosMorne"
    arcpy.HillShade_3d("WesternBrook", "wbrook_hill", 300)
    arcpy.Aspect_3d("WesternBrook", "wbrook_aspect")
    arcpy.CheckInExtension("3D")

except LicenseError:
    print("3D Analyst license is unavailable")
except arcpy.ExecuteError:
    print(arcpy.GetMessages(2))

Related topics