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


INAClassDefinition.CandidateFieldNames Property (ArcObjects .NET 10.6 SDK)
ArcObjects Library Reference (NetworkAnalyst)  

INAClassDefinition.CandidateFieldNames Property

The field names that will be used by default for the network analyst class.

[Visual Basic .NET]
Public Function get_CandidateFieldNames ( _
    ByVal FieldName As String _
) As IStringArray

[C#]
public IStringArray get_CandidateFieldNames (
    string FieldName
);

[C++]
HRESULT get_CandidateFieldNames(
  BSTR FieldName,
  IStringArray** fieldNames
);

[C++]

Parameters
FieldName [in]

  FieldName is a parameter of type BSTR
fieldNames [out, retval]

  fieldNames is a parameter of type IStringArray**

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Network Analyst Extension.

Remarks

CandidateFieldNames returns an IStringArray that contains an array of field names that are used to provide hints to the NAClassFieldMap for how to map input fields to fields on the NAClass.

CandidateFieldNames will be populated with default values if this is the NAClassDefinition from a NAContext that was created with INASolver.CreateContext or had ContextChanged called on it.  For more information, see the help for NAClassDefinition.

You can set the CandidateFieldNames on the INAClassDefinitionEdit interface.

See Also

INAClassDefinition Interface