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


IGPFunction.MetadataFile Property (ArcObjects .NET 10.6 SDK)
ArcObjects Library Reference (Geoprocessing)  

IGPFunction.MetadataFile Property

Name of the (XML) file containing the default metadata for this function object.

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

[C#]
public string MetadataFile {get;}

[C++]
HRESULT get_MetadataFile(
  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.

Description

The MetadataFile property stores the name of a .xml file with the default metadata for a function tool. The .xml file supplies parameter descriptions in the help panel of a tool dialog. If no .chm file is provided through the HelpFile property, a tool's help is based on the .xml file's content.

See Also

IGPFunction Interface