This document is archived and information here might be outdated.  Recommended version.


IGPFunction.HelpFile Property (ArcObjects .NET 10.8 SDK)
ArcObjects Help for .NET developers > ArcObjects Help for .NET developers > ArcObjects namespaces > Geoprocessing > ESRI.ArcGIS.Geoprocessing > Interfaces > IG > IGPFunction Interface > IGPFunction.HelpFile Property
ArcGIS Developer Help

IGPFunction.HelpFile Property

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

[Visual Basic .NET]
Public ReadOnly Property HelpFile As String

[C#]
public string HelpFile {get;}

[C++]
HRESULT get_HelpFile(
  System.String* 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