CheckInExtension

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)
ParameterExplanationData Type
extension_code

Keyword for the extension product that is being checked.

  • 3D3D Analyst
  • SchematicsArcGIS Schematics
  • ArcScanArcScan
  • BusinessBusiness Analyst
  • DataInteroperabilityData Interoperability
  • GeoStatsGeostatistical Analyst
  • JTX Workflow Manager
  • NetworkNetwork Analyst
  • AeronauticalEsri Aeronautical Solution
  • DefenseEsri Defense Solution
  • FoundationEsri Production Mapping
  • DatareviewerArcGIS Data Reviewer
  • NauticalEsri Nautical Solution
  • SpatialSpatial Analyst
  • StreetMapStreetMap
  • TrackingTracking
String
Return Value
Data TypeExplanation
String

There are three possible returned values for CheckInExtension:

  • NotInitializedNo desktop license has been set.
  • FailedA system failure occurred during the request.
  • CheckedIn The license has been returned successfully.

Code Sample

CheckInExtension example

Return 3D extension license to License manager.

class LicenseError(Exception):
    pass

import arcview
import arcpy
from arcpy import env

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

    env.workspace = "D:/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:
    print arcpy.GetMessages(2)

	

Related Topics


10/28/2011