com.esri.arcgis.geoprocessing
Interface IGPFunctionName

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

GPFunctionName, IGPFunctionNameProxy

public interface IGPFunctionName
extends java.io.Serializable

COM Interface 'IGPFunctionName'. Generated 3/19/2015 1:20:58 PM from 'C:\ArcGIS\COM\esriGeoprocessing.olb'

Description: 'Provides access to the properties/methods of a geoprocessing function name object.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IID4cdfd9f9_ae02_460e_aa27_8bd69e06956e
static int	xxDummy Deprecated. Internal use only

Method Summary

int	getHelpContext() The context identifier of the topic within the help file for this function associated with this name object.
java.lang.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(java.lang.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.

Field Detail

IID4cdfd9f9_ae02_460e_aa27_8bd69e06956e

static final int IID4cdfd9f9_ae02_460e_aa27_8bd69e06956e

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

getMinimumProduct

int getMinimumProduct()
                      throws java.io.IOException,
                             AutomationException

The minimum product required to use the function associated with this name object.

Returns:

A com.esri.arcgis.system.esriProductCode constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMinimumProduct

void setMinimumProduct(int product)
                       throws java.io.IOException,
                              AutomationException

The minimum product required to use the function associated with this name object.

Parameters:

product - A com.esri.arcgis.system.esriProductCode constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRequiredExtension

int getRequiredExtension()
                         throws java.io.IOException,
                                AutomationException

The extension, if any, required to use the function associated with this name object.

Returns:

A com.esri.arcgis.system.esriLicenseExtensionCode constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRequiredExtension

void setRequiredExtension(int extension)
                          throws java.io.IOException,
                                 AutomationException

The extension, if any, required to use the function associated with this name object.

Parameters:

extension - A com.esri.arcgis.system.esriLicenseExtensionCode constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHelpFile

java.lang.String getHelpFile()
                             throws java.io.IOException,
                                    AutomationException

Name of the (CHM) file containing help information for this function associated with this name object.

Returns:

The file

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHelpFile

void setHelpFile(java.lang.String file)
                 throws java.io.IOException,
                        AutomationException

Name of the (CHM) file containing help information for this function associated with this name object.

Parameters:

file - The file (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHelpContext

int getHelpContext()
                   throws java.io.IOException,
                          AutomationException

The context identifier of the topic within the help file for this function associated with this name object.

Returns:

The context

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHelpContext

void setHelpContext(int context)
                    throws java.io.IOException,
                           AutomationException

The context identifier of the topic within the help file for this function associated with this name object.

Parameters:

context - The context (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.