Nose: Changed last parameter to pointer

2010-07-17T17:42:53Z

Changed last parameter to pointer

Nose: moved OpenDBX/API/odbx escape to OpenDBX/C API/odbx escape

2009-04-28T21:11:58Z

moved OpenDBX/API/odbx escape to OpenDBX/C API/odbx escape

Nose: 1 revision(s)

2008-05-23T22:49:54Z

1 revision(s)

: docbook2x update

2008-05-23T22:49:54Z

docbook2x update

Nose: 1 revision(s)

2008-05-23T22:33:26Z

1 revision(s)

: docbook2x update

2008-05-23T22:33:26Z

docbook2x update

84.188.200.68: tolen is a pointer.

2007-09-06T08:56:30Z

tolen is a pointer.

Nose: 1 revision(s)

2007-05-19T20:08:36Z

1 revision(s)

: docbook2x update

2007-05-19T20:00:00Z

docbook2x update

Nose: OpenDBX escape moved to OpenDBX/API/odbx escape

2007-05-17T15:15:03Z

OpenDBX escape moved to OpenDBX/API/odbx escape

@@ Line 9: / Line 9: @@
       unsigned long '''''fromlen''''',
       char* '''''to''''',
-      unsigned long '''''tolen''''' )
+      unsigned long* '''''tolen''''' )
 == Description ==

@@ Line 2: / Line 2: @@
 '''Prepare strings for inclusion in statements'''
-  #include <odbx.h>
+  #include <opendbx/api.h>
-−
   int '''odbx_escape'''(
       odbx_t* '''''handle''''',
@@ Line 9: / Line 9: @@
       unsigned long '''''fromlen''''',
       char* '''''to''''',
-      unsigned long* '''''tolen''''' )
+      unsigned long '''''tolen''''' )
 == Description ==
@@ Line 42: / Line 42: @@
 * [[OpenDBX/API/odbx_error_type|odbx_error_type]]()
 * [[OpenDBX/API/odbx_query|odbx_query]]()

@@ Line 9: / Line 9: @@
       unsigned long '''''fromlen''''',
       char* '''''to''''',
-      unsigned long '''''tolen''''' )
+      unsigned long* '''''tolen''''' )
 == Description ==
@@ Line 42: / Line 42: @@
 * [[OpenDBX/API/odbx_error_type|odbx_error_type]]()
 * [[OpenDBX/API/odbx_query|odbx_query]]()
 ----
 Back to [[OpenDBX/API|Overview]]

@@ Line 1: / Line 1: @@
 __NOTOC__
- '''#include <odbx.h>'''
+'''Prepare strings for inclusion in statements'''
   int '''odbx_escape'''(
-      odbx_t* '''handle''',
+      odbx_t* '''''handle''''',
-      const char* '''from''',
+      const char* '''''from''''',
-      unsigned long '''fromlen''',
+      unsigned long '''''fromlen''''',
-      char* '''to''',
+      char* '''''to''''',
-      unsigned long* '''tolen''' )
+      unsigned long '''''tolen''''' )
 == Description ==
-'''odbx_escape()''' neutralizes potentially dangerous characters of the string so it can be used as part of a statement. For security reasons every user input has to be passed to '''odbx_escape()''' to avoid SQL injection attacks which can have fatal consequences! It's also a good idea to escape strings returned from database fields again if you want to use them in a query again because they don't stay escaped.
+[[OpenDBX/API/odbx_escape|odbx_escape]]() neutralizes potentially dangerous characters of the string so it can be used as part of a statement. For security reasons every user input has to be passed to [[OpenDBX/API/odbx_escape|odbx_escape]]() to avoid SQL injection attacks which can have fatal consequences! It's also a good idea to escape strings returned from database fields again if you want to use them in a query because they don't stay escaped once they are returned as part of a record.
-Most backends require the buffer to be more than twice as long as the input string. To be precise, the output buffer must be 2 * size of input + 1 bytes long. After successfully escaping the characters in '''from''', they are written into the memory provided via '''to''' and the value/result parameter '''tolen''' is updated to the new length of '''to''' in the end.
+Most backends require the buffer to be more than twice as long as the input string. To be precise, the output buffer must be 2 * size of input + 1 bytes long. After successfully escaping the characters in '''''from''''', they are written into the memory provided via '''''to''''' and the value/result parameter '''''tolen''''' is updated to the new length of '''''to''''' in the end.
-The first parameter '''handle''' is the connection object created and returned by [[OpenDBX_init|odbx_init()]] which becomes invalid as soon as it was supplied to [[OpenDBX_finish|odbx_finish()]].
+The first parameter '''''handle''''' is the connection object created and returned by [[OpenDBX/API/odbx_init|odbx_init]]() which becomes invalid as soon as it was supplied to [[OpenDBX/API/odbx_finish|odbx_finish]]().
-'''from''' has to point to a character string containing the string which should be used as an argument in a statement. It doesn't have to be zero-terminated because the length of it is also given via '''fromlen'''. The backends may also support variable width character sets like UTF-8 but this function don't support wide char types where each character needs two or four bytes.
+'''''from''''' has to point to a character string containing the string which should be used as part of a statement. It doesn't have to be zero-terminated because the length of it is also given via '''''fromlen'''''. The backends may support variable width character sets like UTF-8 but this function doesn't support the wide char type (wchar_t) where each character has a fixed size of two or four bytes.
-The value of the parameter '''fromlen''' must be the length in bytes of the string which '''from''' is pointing to. This is also true for variable width character sets like UTF-8 but wide char types are not supported. The terminating \0 character shouldn't be part of '''fromlen'''.
+The value of the parameter '''''fromlen''''' must be the length in bytes of the string which '''''from''''' is pointing to. This is also true for variable width character sets like UTF-8 but the wide char type (wchar_t) is not supported. The terminating \0 character shouldn't be part of '''''fromlen'''''.
-The calling function provides a buffer for storing the escaped string via '''to'''. In general, the length of the buffer should be more than twice as long as the string passed via '''from''' to be able to store the escaped string even if every character has to be escaped.
+The calling function provides a buffer for storing the escaped string via '''''to'''''. In general, the length of the buffer should be more than twice as long as the string passed via '''''from''''' to be able to store the escaped string even if every character has to be escaped.
-'''tolen''' is a value-result parameter which points to an integer variable in the calling function. It must contain the original length of the buffer given via '''to''' and if escaping the string in '''from''' suceeded,  '''odbx_escape()''' will store the new length of the escaped string in this variable.
+'''''tolen''''' is a value-result parameter which points to an integer variable in the calling function. It must contain the original length of the buffer given via '''''to''''' and if escaping the string in '''''from''''' suceeded, [[OpenDBX/API/odbx_escape|odbx_escape]]() will store the new length of the escaped string in this variable.
-== Return values ==
+== Return value ==
-'''odbx_escape()''' returns ODBX_ERR_SUCCESS, or an error code whose value is less than zero if one of the operations couldn't be completed successfully. Possible error codes are listed in the error section and they can be feed to [[OpenDBX_error|odbx_error()]] and [[OpenDBX_error_type|odbx_error_type()]] to get further details.
+[[OpenDBX/API/odbx_escape|odbx_escape]]() returns ODBX_ERR_SUCCESS, or an error code whose value is less than zero if one of the operations couldn't be completed successfully. Possible error codes are listed in the error section and they can be feed to [[OpenDBX/API/odbx_error|odbx_error]]() and [[OpenDBX/API/odbx_error_type|odbx_error_type]]() to get further details.
 == Errors ==
@@ Line 37: / Line 39: @@
 == See also ==
-* [[OpenDBX_error]]
+* [[OpenDBX/API/odbx_error|odbx_error]]()
-* [[OpenDBX_error_type]]
+* [[OpenDBX/API/odbx_error_type|odbx_error_type]]()
-* [[OpenDBX_query]]
+* [[OpenDBX/API/odbx_query|odbx_query]]()
 ----
-Back to [[OpenDBX API|Overview]]
+Back to [[OpenDBX/API|Overview]]

← Older revision	Revision as of 21:11, 28 April 2009
(No difference)

← Older revision	Revision as of 22:49, 23 May 2008
(No difference)

← Older revision	Revision as of 22:33, 23 May 2008
(No difference)

← Older revision	Revision as of 20:08, 19 May 2007
(No difference)

← Older revision	Revision as of 15:15, 17 May 2007
(No difference)

OpenDBX/C API/odbx escape - Revision history

Nose: Changed last parameter to pointer

Nose: moved OpenDBX/API/odbx escape to OpenDBX/C API/odbx escape

Nose: 1 revision(s)

: docbook2x update

Nose: 1 revision(s)

: docbook2x update

84.188.200.68: tolen is a pointer.

Nose: 1 revision(s)

: docbook2x update

Nose: OpenDBX escape moved to OpenDBX/API/odbx escape