Recent changes to SerialDriver Instanciation functions

WikiPage SerialDriver Instanciation functions modified by Thierry CHOMAUD

Thierry CHOMAUD — Sat, 12 May 2012 19:30:01 -0000

--- v7 
+++ v8 
@@ -2,7 +2,7 @@
 
 Before using a SerialDriver implementation, an instance of the implementation must be created:
 
-* In C API, 2 methods are available to create or destroy an instance
+* In C API, 2 methods are defined to create or destroy an instance
 * In Java API, native constructor of Java classes must be used
 
 **C source API extract**

WikiPage SerialDriver Instanciation functions modified by Thierry CHOMAUD

Thierry CHOMAUD — Fri, 11 May 2012 13:31:53 -0000

--- v6 
+++ v7 
@@ -5,7 +5,7 @@
 * In C API, 2 methods are available to create or destroy an instance
 * In Java API, native constructor of Java classes must be used
 
-**C API**
+**C source API extract**
 
     /**
      * Create a new serial driver instance

WikiPage SerialDriver Instanciation functions modified by Thierry CHOMAUD

Thierry CHOMAUD — Fri, 11 May 2012 13:28:01 -0000

--- v5 
+++ v6 
@@ -5,7 +5,7 @@
 * In C API, 2 methods are available to create or destroy an instance
 * In Java API, native constructor of Java classes must be used
 
-### C API ###
+**C API**
 
     /**
      * Create a new serial driver instance

WikiPage SerialDriver Instanciation functions modified by Thierry CHOMAUD

Thierry CHOMAUD — Fri, 11 May 2012 13:14:00 -0000

--- v4 
+++ v5 
@@ -1,25 +1,21 @@
-**Load functions**
-
-    /**
-     * Create default driver(port) instance
-     */
-    void* driver_create ()
-    
-Return: a descriptor to created driver. Null if driver failed to be created.
-Code Example: [Driver Create and Destroy example]
-    
-    /**
-     * Close and destroy driver(port)
-     */
-    int driver_destroy ( const void* driver )
-Parameter driver: Driver descriptor to destroy.
-Return : the operation completion status [Serial Driver status codes].
-
-Possible status codes:
-~~~~~~
-    OK_SERIALDRIVER_SUCCESS
-    KO_PARAM_NOT_VALID
-    KO_SERIALPORT_UNEXPECTED_ERROR
-~~~~~~
-
-Code example: [Driver Create and Destroy example]
+##Instanciation functions##
+
+Before using a SerialDriver implementation, an instance of the implementation must be created:
+
+* In C API, 2 methods are available to create or destroy an instance
+* In Java API, native constructor of Java classes must be used
+
+### C API ###
+
+    /**
+     * Create a new serial driver instance
+     * @return a pointer to created serial driver.NULL if driver failed to be created.
+     */
+    WAVENIS_API void* driver_create();
+    
+    /**
+     * Destroy the serial driver instance. It will automatically close the current connection
+     * @param driver The SerialDriver instance
+     * @return 0 if succeed, a positive number otherwise
+     */
+    WAVENIS_API int driver_destroy( const void* driver );

WikiPage SerialDriver Instanciation functions modified by Thierry CHOMAUD

Thierry CHOMAUD — Fri, 11 May 2012 13:07:33 -0000

WikiPage SerialDriver instanciation functions modified by Thierry CHOMAUD

Thierry CHOMAUD — Fri, 11 May 2012 12:53:08 -0000

--- v2 
+++ v3 
@@ -1,4 +1,3 @@
-
 **Load functions**
 
     /**

WikiPage Serial Driver Load Functions modified by vmacari

vmacari — Tue, 08 May 2012 12:43:02 -0000

--- v1 
+++ v2 
@@ -1,4 +1,4 @@
--------------------------------------------------------------------
+
 **Load functions**
 
     /**

WikiPage Serial Driver Load Functions modified by vmacari

vmacari — Tue, 08 May 2012 12:42:25 -0000

------------------------------------------------------------------- **Load functions** /** * Create default driver(port) instance */ void* driver_create () Return: a descriptor to created driver. Null if driver failed to be created. Code Example: [Driver Create and Destroy example] /** * Close and destroy driver(port) */ int driver_destroy ( const void* driver ) Parameter driver: Driver descriptor to destroy. Return : the operation completion status [Serial Driver status codes]. Possible status codes: ~~~~~~ OK_SERIALDRIVER_SUCCESS KO_PARAM_NOT_VALID KO_SERIALPORT_UNEXPECTED_ERROR ~~~~~~ Code example: [Driver Create and Destroy example]