*** sgml.orig/libpq.sgml Sun Nov 18 19:58:23 2001
--- sgml/libpq.sgml Tue Nov 20 12:16:30 2001
***************
*** 903,908 ****
--- 903,958 ----
+
+
+ Escaping binary strings for inclusion in SQL queries
+
+ escaping binary strings
+
+
+ PQescapeBytea
+ Escapes a binary string (bytea type) for use within an SQL query.
+
+ unsigned char *PQescapeBytea(unsigned char *from,
+ size_t from_length,
+ size_t *to_length);
+
+
+ Certain ASCII characters MUST be escaped (but all
+ characters MAY be escaped) when used as part of a BYTEA
+ string literal in an SQL statement. In general, to
+ escape a character, it is converted into the three digit octal number
+ equal to the decimal ASCII value, and preceeded by
+ two backslashes. The single quote (') and backslash (\) characters have
+ special alternate escape sequences. See the Binary String data type
+ in the User's Guide for more information. PQescapeBytea
+ performs this operation, escaping only the minimally
+ required characters.
+
+
+
+ The from parameter points to the first
+ character of the string that is to be escaped, and the
+ from_length parameter reflects the number of
+ characters in this binary string (a terminating NUL character is
+ neither necessary nor counted). The to_length
+ parameter shall point to a buffer suitable to hold the resultant
+ escaped string length. The result string length does not
+ include the terminating NUL character of the result.
+
+
+
+ PQescapeBytea returns an escaped version of the
+ from parameter binary string, to a caller
+ provided buffer. The return string has all special characters replaced
+ so that they can be properly processed by the PostgreSQL string literal
+ parser, and the bytea input function. A terminating NUL
+ character is also added. The single quotes that must surround
+ PostgreSQL string literals are not part of the result string.
+
+
+
+
Retrieving SELECT Result Information