ArcMap

CheckOutExtension

Résumé

Retrieves the license from the License Manager.

Once the extension license has been retrieved by the script, tools using that extension can be used. Once a script is finished with an extension's tools, the CheckInExtension function should be used to return the license to the License Manager so other applications can use it. All checked-out extension licenses and set product licenses are returned to the License Manager when a script completes.

Discussion

Syntaxe

CheckOutExtension (extension_code)
ParamètreExplicationType de données
extension_code

Keyword for the extension product that is being checked.

  • 3D —ArcGIS 3D Analyst extension
  • Aeronautical —ArcGIS Aviation Charting
  • Airports —ArcGIS Aviation Airports
  • ArcScan —ArcScan
  • Bathymetry —ArcGIS Bathymetry
  • Business —ArcGIS Business Analyst
  • DataReviewer —ArcGIS Data Reviewer Desktop
  • DataInteroperability —ArcGIS Data Interoperability extension for Desktop
  • Defense —ArcGIS Defense Mapping
  • Foundation —ArcGIS Production Mapping
  • GeoStats —ArcGIS Geostatistical Analyst extension
  • Highways —ArcGIS Roads and Highways
  • JTX —ArcGIS Workflow Manager (Classic) Desktop
  • LocationReferencing —ArcGIS Pipeline Referencing
  • Nautical —ArcGIS Maritime
  • Network —ArcGIS Network Analyst extension
  • Publisher —ArcGIS Publisher
  • Schematics —ArcGIS Schematics extension
  • SMPAsiaPacific —StreetMap Premium Asia Pacific
  • SMPEurope —StreetMap Premium Europe
  • SMPJapan —StreetMap Premium Japan
  • SMPLatinAmerica —StreetMap Premium Latin America
  • SMPMiddleEastAfrica —StreetMap Premium Middle East Africa
  • SMPNorthAmerica —StreetMap Premium North America
  • Spatial —ArcGIS Spatial Analyst extension
  • Tracking —ArcGIS Tracking Analyst extension
String

Valeur renvoyée

Type de donnéesExplication
String

There are three possible returned values for CheckOutExtension:

  • NotInitialized —No desktop license has been set.
  • Unavailable —The requested license is unavailable to be set.
  • CheckedOut —The license has been set successfully.

Exemple de code

CheckOutExtension example

Check out 3D extension for use by tools.

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))

Rubriques connexes