IPlugInDatasetHelper.FetchByEnvelope Method

Gets the records within the envelope (or the full extent if the envelope is null).

[Visual Basic .NET]
Public Function FetchByEnvelope ( _
    ByVal ClassIndex As Integer, _
    ByVal env As IEnvelope, _
    ByVal strictSearch As Boolean, _
    ByVal WhereClause As String, _
    ByVal FieldMap As Object _
) As IPlugInCursorHelper

[C#]
public IPlugInCursorHelper FetchByEnvelope (
    int ClassIndex,
    IEnvelope env,
    bool strictSearch,
    string WhereClause,
    object FieldMap
);

[C++]
HRESULT FetchByEnvelope(
  long ClassIndex,
  IEnvelope* env,
  VARIANT_BOOL strictSearch,
  BSTR WhereClause,
  VARIANT FieldMap,
  IPlugInCursorHelper** cursorHelper
);

[C++]
Parameters
ClassIndex [in]
  ClassIndex is a parameter of type long
env [in]
  env is a parameter of type IEnvelope
strictSearch [in]
  strictSearch is a parameter of type VARIANT_BOOL
WhereClause [in]
  WhereClause is a parameter of type BSTR
FieldMap [in]
  FieldMap is a parameter of type VARIANT
cursorHelper [out, retval]
  cursorHelper is a parameter of type IPlugInCursorHelper

Product Availability

Description

Returns a record set of all records that are in the envelope and that match the optional where clause.  The where clause will always be null if IPlugInWorkspaceFactoryHelper::CanSupportSQL returns false. The method should fail if there are no records in the envelope that match the optional where clause.

Fieldmap indicates which fields should be returned by the query.  See IPlugInCursorHelper::QueryValues and IPlugInFastQueryValues::FastQueryValues for a description of how to use the field map.

Many data sources use spatial indexes or other spatial organization methods.  If strictSearch is false, these data sources should return a cursor containing all the records which are in indexes or blocks within the query envelope. If strictSearch is true, the cursor should contain only the records within the envelope. Data sources that dont use indexes or blocks may ignore this parameter.

Remarks

The FetchByEnvelope function returns all records in the Dataset if the Envelope parameter given is Nothing.

See Also