CheckInExtension (arcpy)

Summary

Returns the license to the License Manager so other applications can use it.

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.

Syntax

CheckInExtension (extension_code)

Parameter	Explanation	Data Type
extension_code	Keyword for the extension product that is being checked. 3D —3D Analyst Schematics —ArcGIS Schematics ArcScan —ArcScan Business —Business Analyst DataInteroperability —Data Interoperability GeoStats —Geostatistical Analyst JTX — Workflow Manager Network —Network Analyst Aeronautical —Esri Aeronautical Solution Defense —Esri Defense Solution Foundation —Esri Production Mapping Datareviewer —ArcGIS Data Reviewer Nautical —Esri Nautical Solution Nauticalb —Esri Bathymetry Spatial —Spatial Analyst StreetMap —StreetMap Tracking —Tracking Licensing and extensions	String

Return Value

Data Type	Explanation
String	There are three possible returned values for CheckInExtension: NotInitialized —No desktop license has been set. Failed —A system failure occurred during the request. CheckedIn — The license has been returned successfully.

Code Sample

CheckInExtension example

Return 3D extension license to License manager.

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