INAAgent.Applies Method

Indicates if the agent is appropriate to use with the given network dataset.

[Visual Basic .NET]
Public Function Applies ( _
    ByVal network As IDENetworkDataset, _
    ByVal contextHelper As INAContextHelper _
) As Boolean

[C#]
public bool Applies (
    IDENetworkDataset network,
    INAContextHelper contextHelper
);

[C++]
HRESULT Applies(
  IDENetworkDataset* network,
  INAContextHelper* contextHelper,
  VARIANT_BOOL* agentApplies
);

[C++]

Parameters
network [in]

  network is a parameter of type IDENetworkDataset
contextHelper [in]

  contextHelper is a parameter of type INAContextHelper
agentApplies [out, retval]
  agentApplies is a parameter of type VARIANT_BOOL

Product Availability

Remarks

The method Applies indicates if the NAAgent should be attached to the NAContext referenced by the input INAContextHelper. 

Applies returns true if the agent is applicable and has not already been attached to the NAContext.  For example, a NAStreetDirectionsAgent will only apply to solvers that support driving directions.

See Also