[mapserver-commits] r7847 - in trunk/mapserver/mapscript: doc swiginc

[svn at osgeo.org]

Author: tamas
Date: 2008-08-14 06:23:11 -0400 (Thu, 14 Aug 2008)
New Revision: 7847

Modified:
   trunk/mapserver/mapscript/doc/mapscript.txt
   trunk/mapserver/mapscript/swiginc/layer.i
Log:
Change connectLayer to setConnectionType at the SWIG API (#2735)

Modified: trunk/mapserver/mapscript/doc/mapscript.txt
===================================================================
--- trunk/mapserver/mapscript/doc/mapscript.txt	2008-08-14 04:30:09 UTC (rev 7846)
+++ trunk/mapserver/mapscript/doc/mapscript.txt	2008-08-14 10:23:11 UTC (rev 7847)
@@ -1208,6 +1208,8 @@
 
 connectiontype : int
     See MS_CONNECTION_TYPE in mapserver.h for possible values.
+    When setting the connection type setConnectionType() should be
+    used in order to initialize the layer vtable properly.
 
 data : string
     Layer data definition, values depend upon connectiontype.
@@ -1389,13 +1391,8 @@
 close() : void
     Close the underlying layer.
 
-.. note:: demote() is removed in MapServer 4.4
+.. note:: demote() is removed in MapServer 4.4  
 
-connectLayer(int connectiontype, string library_str) : int
-    Changes the connectiontype of the layer and recreates the vtable
-    according to the new connection type. This method should be used
-    instead of setting the connectiontype parameter directly.    
-
 draw( mapObj_ map, imageObj_ image ) : int
     Renders this layer into the target image, adding labels to the cache if
     required.  Returns MS_SUCCESS or MS_FAILURE. 
@@ -1607,6 +1604,14 @@
 
 .. note:: removeMetaData() is deprecated and will be removed in a future
           version.  Replaced by direct metadata access, see hashTableObj_.
+          
+setConnectionType(int connectiontype, string library_str) : int
+    Changes the connectiontype of the layer and recreates the vtable
+    according to the new connection type. This method should be used
+    instead of setting the connectiontype parameter directly.
+    In case when the layer.connectiontype = MS_PLUGIN the library_str 
+    parameter should also be specified so as to select the library to load by
+    mapserver. For the other connection types this parameter is not used.
 
 setExtent( float minx, float miny, float maxx, float maxy ) : int
     Sets the extent of a layer.  Returns MS_SUCCESS or MS_FAILURE.

Modified: trunk/mapserver/mapscript/swiginc/layer.i
===================================================================
--- trunk/mapserver/mapscript/swiginc/layer.i	2008-08-14 04:30:09 UTC (rev 7846)
+++ trunk/mapserver/mapscript/swiginc/layer.i	2008-08-14 10:23:11 UTC (rev 7847)
@@ -545,7 +545,7 @@
         return msLayerClearProcessing(self);
     }
     
-    int connectLayer(int connectiontype,
+    int setConnectionType(int connectiontype,
                             char *library_str) 
     {    
         return msConnectLayer(self, connectiontype, library_str);