| 1 | <?xml version="1.0" encoding="utf-8"?> |
|---|
| 2 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
|---|
| 3 | <html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>SetRowCount Method</title><link rel="stylesheet" type="text/css" href="lib.css?format=raw" /><style xml:space="preserve"> |
|---|
| 4 | td.metadataTitle { font-size: 80%; font-weight: bold; font-family: avantgarde, sans-serif; } |
|---|
| 5 | td.metadataValue { padding-left: 0.5em; } |
|---|
| 6 | </style></head><body><div class="navigation"><div><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="Open Method" href="Method_GeoEco.DatabaseAccess.ADO.ADOUpdateCursor.Open.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="ADOUpdateCursor Class" href="Class_GeoEco.DatabaseAccess.ADO.ADOUpdateCursor.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="SetValue Method" href="Method_GeoEco.DatabaseAccess.ADO.ADOUpdateCursor.SetValue.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Method_GeoEco.DatabaseAccess.ADO.ADOUpdateCursor.Open.html?format=raw">Open Method</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DatabaseAccess.ADO.ADOUpdateCursor.html?format=raw">ADOUpdateCursor Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Method_GeoEco.DatabaseAccess.ADO.ADOUpdateCursor.SetValue.html?format=raw">SetValue Method</a> </div><hr /></div></div><h1><tt class="member">SetRowCount</tt> Method</h1><p>Sets the number of rows expected to be retrieved by this cursor.</p><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td class="metadataTitle">Class:</td><td class="metadataValue"><tt class="class"><a href="Class_GeoEco.DatabaseAccess.ADO.ADOUpdateCursor.html?format=raw">ADOUpdateCursor</a></tt></td></tr><tr valign="baseline"><td class="metadataTitle">Intended use:</td><td class="metadataValue"><span style="color: red;">Intended for GeoEco internal use only; not recommended for external callers</span></td></tr><tr valign="baseline"><td class="metadataTitle">COM:</td><td class="metadataValue">Not exposed by a COM class</td></tr><tr valign="baseline"><td class="metadataTitle">ArcGIS:</td><td class="metadataValue">Not exposed as an ArcGIS geoprocessing tool</td></tr><tr valign="baseline"><td class="metadataTitle">Method type:</td><td class="metadataValue">Instance Method</td></tr></table><h3>Usage</h3><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td style="white-space: nowrap;"><var>cursor.</var><b><tt class="method">SetRowCount</tt></b>(</td><td><var>rowCount</var>)</td></tr></table><h3>Arguments</h3><dl><dt><var>rowCount</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">int</tt> or <tt class="class">None</tt></td></tr></table><p>The number of rows that will be retrieved by this cursor, or None |
|---|
| 7 | if the number of rows is not known.</p><p>If you call this method after rows have been inserted, those rows |
|---|
| 8 | should be included in the row count. In other words, this parameter |
|---|
| 9 | represents the total number of rows inserted, not the number |
|---|
| 10 | remaining.</p></dd></dl><h3>Remarks</h3><p>This estimated row count is only used in reporting progress to the |
|---|
| 11 | user. If a value is provided, the progress reports will include the |
|---|
| 12 | number of rows remaining and an estimated time of completion. If a |
|---|
| 13 | None is not provided, the progress reports will only include the |
|---|
| 14 | number of rows retrieved so far.</p><p>Normally, the estimated row count is provided when the cursor is |
|---|
| 15 | opened. It may also be set after the cursor is opened by calling this |
|---|
| 16 | method. This method will fail if the cursor is not open.</p><p>If neither the estimated row count nor the WHERE clause is provided |
|---|
| 17 | when the cursor is opened, and the underlying database supports |
|---|
| 18 | retrieval of row counts (i.e. GetRowCountSupported is True), then the |
|---|
| 19 | row count will be obtained from the database when the cursor is |
|---|
| 20 | opened. If this method is subsequently called with a new value, it |
|---|
| 21 | will overwrite the value obtained from the database.</p><div class="navigation"><div class="online-navigation"><p></p><hr /><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="Open Method" href="Method_GeoEco.DatabaseAccess.ADO.ADOUpdateCursor.Open.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="ADOUpdateCursor Class" href="Class_GeoEco.DatabaseAccess.ADO.ADOUpdateCursor.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="SetValue Method" href="Method_GeoEco.DatabaseAccess.ADO.ADOUpdateCursor.SetValue.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Method_GeoEco.DatabaseAccess.ADO.ADOUpdateCursor.Open.html?format=raw">Open Method</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DatabaseAccess.ADO.ADOUpdateCursor.html?format=raw">ADOUpdateCursor Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Method_GeoEco.DatabaseAccess.ADO.ADOUpdateCursor.SetValue.html?format=raw">SetValue Method</a> </div><hr /><span class="release-info">Marine Geospatial Ecology Tools version 0.7a1</span></div></div></body></html> |
|---|