[mapserver-commits] r9833 - branches/branch-5-6/docs/en/mapscript

[svn at osgeo.org]

Author: jmckenna
Date: 2010-02-21 09:14:04 -0500 (Sun, 21 Feb 2010)
New Revision: 9833

Modified:
   branches/branch-5-6/docs/en/mapscript/mapscript.txt
Log:
document resultsGetShape() - ticket:3140) --username jmckenna

Modified: branches/branch-5-6/docs/en/mapscript/mapscript.txt
===================================================================
--- branches/branch-5-6/docs/en/mapscript/mapscript.txt	2010-02-21 06:20:34 UTC (rev 9832)
+++ branches/branch-5-6/docs/en/mapscript/mapscript.txt	2010-02-21 14:14:04 UTC (rev 9833)
@@ -1250,6 +1250,12 @@
     The function basically prepares things so that candidate features can be 
     accessed by query or drawing functions (eg using nextShape function).
     Returns MS_SUCCESS or MS_FAILURE.
+    
+resultsGetShape(int shapeindex [, int tileindex = -1]) : shapeObj 
+    Retrieve shapeObj from a layer's resultset by index.
+    Tileindex is optional and is used only for tiled shapefiles, 
+    Simply omit or pass tileindex = -1 for other data sources.
+    Added in MapServer 5.6.0 due to the one-pass query implementation.
 
 -----------------------------------------------------------------------------
  legendObj