IPlugInDatasetHelper.FetchAll Method

Gets all the records in the database.

[Visual Basic .NET]
Public Function FetchAll ( _
    ByVal ClassIndex As Integer, _
    ByVal WhereClause As String, _
    ByVal FieldMap As Object _
) As IPlugInCursorHelper

[C#]
public IPlugInCursorHelper FetchAll (
    int ClassIndex,
    string WhereClause,
    object FieldMap
);

[C++]
HRESULT FetchAll(
  long ClassIndex,
  BSTR WhereClause,
  VARIANT FieldMap,
  IPlugInCursorHelper** cursorHelper
);

[C++]
Parameters
ClassIndex [in]
  ClassIndex is a parameter of type long
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 cursor of all the records in the dataset that match the optional where clause. An empty or null where clause means all records should be returned. The where clause will always be null if IPlugInWorkspaceFactoryHelper::CanSupportSQL returns false. The method should fail if there are no records.

The field map 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.

See Also