com.esri.arcgis.geoprocessing
Interface IGPFunctionName

All Superinterfaces:
Serializable
All Known Implementing Classes:
GPFunctionName

public interface IGPFunctionName
extends Serializable

Provides access to the properties/methods of a geoprocessing function name object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows


Method Summary
 int getHelpContext()
          The context identifier of the topic within the help file for this function associated with this name object.
 String getHelpFile()
          Name of the (CHM) file containing help information for this function associated with this name object.
 int getMinimumProduct()
          The minimum product required to use the function associated with this name object.
 int getRequiredExtension()
          The extension, if any, required to use the function associated with this name object.
 void setHelpContext(int context)
          The context identifier of the topic within the help file for this function associated with this name object.
 void setHelpFile(String file)
          Name of the (CHM) file containing help information for this function associated with this name object.
 void setMinimumProduct(int product)
          The minimum product required to use the function associated with this name object.
 void setRequiredExtension(int extension)
          The extension, if any, required to use the function associated with this name object.
 

Method Detail

getMinimumProduct

int getMinimumProduct()
                      throws IOException,
                             AutomationException
The minimum product required to use the function associated with this name object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows

Returns:
A com.esri.arcgis.system.esriProductCode constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMinimumProduct

void setMinimumProduct(int product)
                       throws IOException,
                              AutomationException
The minimum product required to use the function associated with this name object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows

Parameters:
product - A com.esri.arcgis.system.esriProductCode constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRequiredExtension

int getRequiredExtension()
                         throws IOException,
                                AutomationException
The extension, if any, required to use the function associated with this name object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
A com.esri.arcgis.system.esriLicenseExtensionCode constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRequiredExtension

void setRequiredExtension(int extension)
                          throws IOException,
                                 AutomationException
The extension, if any, required to use the function associated with this name object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
extension - A com.esri.arcgis.system.esriLicenseExtensionCode constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHelpFile

String getHelpFile()
                   throws IOException,
                          AutomationException
Name of the (CHM) file containing help information for this function associated with this name object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows

Returns:
The file
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setHelpFile

void setHelpFile(String file)
                 throws IOException,
                        AutomationException
Name of the (CHM) file containing help information for this function associated with this name object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows

Parameters:
file - The file (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHelpContext

int getHelpContext()
                   throws IOException,
                          AutomationException
The context identifier of the topic within the help file for this function associated with this name object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows

Returns:
The context
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setHelpContext

void setHelpContext(int context)
                    throws IOException,
                           AutomationException
The context identifier of the topic within the help file for this function associated with this name object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows

Parameters:
context - The context (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.