IErrorFeatureContainer.ErrorFeaturesByRuleType Property

An enumeration of error features that match the passed in parameters.

[Visual Basic .NET]
Public Function get_ErrorFeaturesByRuleType ( _
    ByVal SpatialReference As ISpatialReference, _
    ByVal TopologyRuleType As esriTopologyRuleType, _
    ByVal Extent As IEnvelope, _
    ByVal Errors As Boolean, _
    ByVal Exceptions As Boolean _
) As IEnumTopologyErrorFeature

[C#]
public IEnumTopologyErrorFeature get_ErrorFeaturesByRuleType (
    ISpatialReference SpatialReference,
    esriTopologyRuleType TopologyRuleType,
    IEnvelope Extent,
    bool Errors,
    bool Exceptions
);

[C++]
HRESULT get_ErrorFeaturesByRuleType(
  ISpatialReference* SpatialReference,
  esriTopologyRuleType TopologyRuleType,
  IEnvelope* Extent,
  VARIANT_BOOL Errors,
  VARIANT_BOOL Exceptions,
  IEnumTopologyErrorFeature** ErrorFeatures
);

[C++]
Parameters
SpatialReference [in]
  SpatialReference is a parameter of type ISpatialReference
TopologyRuleType [in]
  TopologyRuleType is a parameter of type esriTopologyRuleType
Extent [in]
  Extent is a parameter of type IEnvelope
Errors [in]
  Errors is a parameter of type VARIANT_BOOL
Exceptions [in]
  Exceptions is a parameter of type VARIANT_BOOL
ErrorFeatures [out, retval]
  ErrorFeatures is a parameter of type IEnumTopologyErrorFeature

Product Availability

Errors Returned

ErrorFeaturesByRuleType will return an error if:

• False is specified for Errors and Exceptions
• an invalid esriTopologyRuleType is specified for TopologyRuleType

Remarks

ErrorFeaturesByRuleType will return an enumeration of error features belonging to the type of topology rule that is supplied.  This is different from ErrorFeatures which returns the error features belonging to a particular rule of the Topology. The enumeration can contain Errors, errors marked as Exceptions or Both. To determine if a TopologyErrorFeature has been marked as an Exception, use the ITopologyErrorFeature::IsException property. If no error feature exists that matches the parameters, an empty enumeration is returned.

ErrorFeaturesByRuleType requires the spatial reference of the Topology, this can be obtained from the IGeoDataset interface.

See Also