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


INALocatorFeatureAgent2.WhereClause Property (ArcObjects .NET 10.5 SDK)
ArcObjects Help for .NET developers > ArcObjects namespaces > NetworkAnalyst > ESRI.ArcGIS.NetworkAnalyst > Interfaces > IN > INALocatorFeatureAgent2 Interface > INALocatorFeatureAgent2.WhereClause Property (ArcObjects .NET 10.5 SDK)
ArcObjects Library Reference (NetworkAnalyst)  

INALocatorFeatureAgent2.WhereClause Property

The where clause to filter candidate locations not including the subtype predicate in the UseSubtype case.

[Visual Basic .NET]
Public Property WhereClause As String

[C#]
public string WhereClause {get; set;}

[C++]
HRESULT get_WhereClause(
  BSTR* WhereClause
);

[C++]
HRESULT put_WhereClause(
  BSTR WhereClause
);

[C++]

Parameters
WhereClause [out, retval]
  WhereClause is a parameter of type BSTR
WhereClause [in]
  WhereClause is a parameter of type BSTR

Product Availability

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

Remarks

The WhereClause specifies the user-defined portion of the where clause on the spatial filter that is used to constrain the features searched within the source feature class when finding the closest network location.

This is useful if you don't want to locate on features that may be restricted or otherwise undesirable to search on.  For example, if you are using StreetMap network data, streets with a Speed of 1 are considered restricted.  Thus, you may want to specify a where clause of "SPEED > 1" to ensure there streets are not considered when finding network locations.

See Also

INALocatorFeatureAgent2 Interface