ArcObjects Library Reference (Geoprocessing)  

IGpDispatch.SearchCursor Method

Returns a search cursor object against the given table/feature class.

[Visual Basic .NET]
Public Function SearchCursor ( _
    ByRef pInputValue As Object, _
    [ByRef WhereClause As Object], _
    [ByRef SpRef As Object], _
    [ByRef Fields As Object], _
    [ByRef sortFields As Object] _
) As Object
[C#]
public object SearchCursor (
    ref object pInputValue,
    ref object WhereClause,
    ref object SpRef,
    ref object Fields,
    ref object sortFields
);
[C#]

Optional Values

WhereClause   To indicate that this parameter is undefined, first define a variable object Missing = Type.Missing; then pass this in as ref Missing.
SpRef   To indicate that this parameter is undefined, first define a variable object Missing = Type.Missing; then pass this in as ref Missing.
Fields   To indicate that this parameter is undefined, first define a variable object Missing = Type.Missing; then pass this in as ref Missing.
sortFields   To indicate that this parameter is undefined, first define a variable object Missing = Type.Missing; then pass this in as ref Missing.
[C++]
HRESULT SearchCursor(
  VARIANT* pInputValue,
  VARIANT* WhereClause,
  VARIANT* SpRef,
  VARIANT* Fields,
  VARIANT* sortFields,
  IDispatch** ppCursor
);
[C++]

Parameters

pInputValue [in]
  pInputValue is a parameter of type VARIANT
WhereClause [optional]
  WhereClause is a parameter of type VARIANT

  To indicate this parameter is undefined pass a reference to a VARIANT with type VT_ERROR and scode value of DISP_E_PARAMNOTFOUND.

SpRef [optional]
  SpRef is a parameter of type VARIANT

  To indicate this parameter is undefined pass a reference to a VARIANT with type VT_ERROR and scode value of DISP_E_PARAMNOTFOUND.

Fields [optional]
  Fields is a parameter of type VARIANT

  To indicate this parameter is undefined pass a reference to a VARIANT with type VT_ERROR and scode value of DISP_E_PARAMNOTFOUND.

sortFields [optional]
  sortFields is a parameter of type VARIANT

  To indicate this parameter is undefined pass a reference to a VARIANT with type VT_ERROR and scode value of DISP_E_PARAMNOTFOUND.

ppCursor [out, retval]
  ppCursor is a parameter of type IDispatch*

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

See Also

IGpDispatch Interface