ArcGIS Desktop

  • ArcGIS Pro
  • ArcMap

  • My Profile
  • Help
  • Sign Out
ArcGIS Desktop

ArcGIS Online

The mapping platform for your organization

ArcGIS Desktop

A complete professional GIS

ArcGIS Enterprise

GIS in your enterprise

ArcGIS Developers

Tools to build location-aware apps

ArcGIS Solutions

Free template maps and apps for your industry

ArcGIS Marketplace

Get apps and data for your organization

  • Documentation
  • Support
Esri
  • Sign In
user
  • My Profile
  • Sign Out

ArcMap

  • Home
  • Get Started
  • Map
  • Analyze
  • Manage Data
  • Tools
  • Extensions

GetArgumentCount

  • Summary
  • Syntax
  • Code sample

Summary

Returns the number of arguments passed to the script.

Syntax

GetArgumentCount ()

Return Value

Data TypeExplanation
Integer

The number of arguments passed to the script.

Code sample

GetArgumentCount example 1

Check for required number of arguments to run the Clip tool and handle optional argument.

import arcpy

# Set workspace
arcpy.env.workspace = "c:/data/airport.gdb"

# Set local variables
in_features = arcpy.GetParameterAsText(0)
clip_features = arcpy.GetParameterAsText(1)
out_feature_class = arcpy.GetParameterAsText(2)
xy_tolerance = arcpy.GetParameterAsText(3)

# Check for required number of arguments
if arcpy.GetArgumentCount() < 3:
    print("3 arguments required for Clip_analysis tool")

# Execute Clip tool
try:
    arcpy.Clip_analysis(in_features, clip_features,
                        out_feature_class, xy_tolerance)
except arcpy.ExecuteError:
    print(arcpy.GetMessages(2))
GetArgumentCode example 2

The following sample uses the GetArgumentCount and GetParameterAsText functions to assign all parameter values in a script tool to a single variable as a list of values.

import arcpy

args = [arcpy.GetParameterAsText(i) for i in range(arcpy.GetArgumentCount())]

Related topics

  • CopyParameter
  • GetParameter
  • GetParameterAsText
  • GetParameterCount
  • GetParameterInfo
  • GetParameterValue
  • SetParameter
  • SetParameterAsText
  • Setting script tool parameters

ArcGIS Desktop

  • Home
  • Documentation
  • Support

ArcGIS

  • ArcGIS Online
  • ArcGIS Desktop
  • ArcGIS Enterprise
  • ArcGIS
  • ArcGIS Developer
  • ArcGIS Solutions
  • ArcGIS Marketplace

About Esri

  • About Us
  • Careers
  • Esri Blog
  • User Conference
  • Developer Summit
Esri
Tell us what you think.
Copyright © 2021 Esri. | Privacy | Legal