com.esri.arcgis.geoprocessing
Interface IGpCursorRow

All Superinterfaces:
Serializable
All Known Subinterfaces:
IGpCursorRow2
All Known Implementing Classes:
IGpCursorRow2Proxy, IGpCursorRowProxy

public interface IGpCursorRow
extends Serializable

Provides access to the Cursor Row.

Superseded By

IGpCursorRow2

Product Availability

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

Supported Platforms

Windows


Method Summary
 void deleteRow(ICursor pCursor, int cursorCookie)
          Deletes the existing row of the current position of the cursor.
 Object getValue(String field)
          Returns the value of the specified field in the row object.
 void insertRow(ICursor pCursor, int cursorCookie)
          Inserts a new row into the data source of the given cursor using the values of this row object.
 boolean isNull(String field)
          Indicates whether or not the value of the specified field in the row object is NULL.
 void setNull(String field)
          Sets the value of the specified field to NULL in the row object.
 void setRow(IRowBuffer pRowBuffer, IPropertySet pRowSet)
          Sets this row object with a new row.
 void setValue(String field, Object value)
          Sets the value of the specified field in the row object.
 void updateRow(ICursor pCursor, int cursorCookie)
          Updates the existing row of the current position of the cursor with the values of this row object.
 

Method Detail

updateRow

void updateRow(ICursor pCursor,
               int cursorCookie)
               throws IOException,
                      AutomationException
Updates the existing row of the current position of the cursor with the values of this row object.

Product Availability

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

Supported Platforms

Windows

Parameters:
pCursor - A reference to a com.esri.arcgis.geodatabase.ICursor (in)
cursorCookie - The cursorCookie (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

insertRow

void insertRow(ICursor pCursor,
               int cursorCookie)
               throws IOException,
                      AutomationException
Inserts a new row into the data source of the given cursor using the values of this row object.

Product Availability

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

Supported Platforms

Windows

Parameters:
pCursor - A reference to a com.esri.arcgis.geodatabase.ICursor (in)
cursorCookie - The cursorCookie (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deleteRow

void deleteRow(ICursor pCursor,
               int cursorCookie)
               throws IOException,
                      AutomationException
Deletes the existing row of the current position of the cursor.

Product Availability

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

Supported Platforms

Windows

Parameters:
pCursor - A reference to a com.esri.arcgis.geodatabase.ICursor (in)
cursorCookie - The cursorCookie (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setValue

void setValue(String field,
              Object value)
              throws IOException,
                     AutomationException
Sets the value of the specified field in the row object.

Product Availability

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

Supported Platforms

Windows

Parameters:
field - The field (in)
value - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getValue

Object getValue(String field)
                throws IOException,
                       AutomationException
Returns the value of the specified field in the row object.

Product Availability

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

Supported Platforms

Windows

Parameters:
field - The field (in)
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setNull

void setNull(String field)
             throws IOException,
                    AutomationException
Sets the value of the specified field to NULL in the row object.

Product Availability

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

Supported Platforms

Windows

Parameters:
field - The field (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isNull

boolean isNull(String field)
               throws IOException,
                      AutomationException
Indicates whether or not the value of the specified field in the row object is NULL.

Product Availability

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

Parameters:
field - The field (in)
Returns:
The isNull
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRow

void setRow(IRowBuffer pRowBuffer,
            IPropertySet pRowSet)
            throws IOException,
                   AutomationException
Sets this row object with a new row.

Product Availability

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

Parameters:
pRowBuffer - A reference to a com.esri.arcgis.geodatabase.IRowBuffer (in)
pRowSet - A reference to a com.esri.arcgis.system.IPropertySet (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.