ArcObjects Library Reference  (Geoprocessing)    

IGPFunction.HelpFile Property

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

[Visual Basic 6.0]
Property HelpFile As String
[Visual Basic .NET]
Public ReadOnly Property HelpFile As String
[C#]
public string HelpFile {get;}
[Java]
public String getHelpFile()
throws
    IOException,
    AutomationException
[C++]
HRESULT get_HelpFile(
  BSTR* File
);
[C++]

Parameters

File [out, retval]

  File is a parameter of type BSTR

Product Availability

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

Remarks

The HelpFile porperty stores the path to a .chm file which contains a description of the tool parameters and explains the tool's operation and usage.

See Also

IGPFunction Interface

 


Feedback Send feedback on this page