summaryrefslogtreecommitdiff
path: root/doc/src/sgml
diff options
context:
space:
mode:
authorTom Lane2005-05-03 19:17:59 +0000
committerTom Lane2005-05-03 19:17:59 +0000
commit893b57c871b97c9324e3eea77409e487a1e22ae8 (patch)
treea2ea524111de0cca4e4b14987170b6c9a1728774 /doc/src/sgml
parent177af51c04528f0edb4d5dc632297c3c796a47f9 (diff)
Alter the signature for encoding conversion functions to declare the
output area as INTERNAL not CSTRING. This is to prevent people from calling the functions by hand. This is a permanent solution for the back branches but I hope it is just a stopgap for HEAD.
Diffstat (limited to 'doc/src/sgml')
-rw-r--r--doc/src/sgml/ref/create_conversion.sgml14
1 files changed, 8 insertions, 6 deletions
diff --git a/doc/src/sgml/ref/create_conversion.sgml b/doc/src/sgml/ref/create_conversion.sgml
index 3b941b80bb1..9bf88807c14 100644
--- a/doc/src/sgml/ref/create_conversion.sgml
+++ b/doc/src/sgml/ref/create_conversion.sgml
@@ -1,4 +1,4 @@
-<!-- $PostgreSQL: pgsql/doc/src/sgml/ref/create_conversion.sgml,v 1.15 2005/03/07 04:30:51 momjian Exp $ -->
+<!-- $PostgreSQL: pgsql/doc/src/sgml/ref/create_conversion.sgml,v 1.16 2005/05/03 19:17:59 tgl Exp $ -->
<refentry id="SQL-CREATECONVERSION">
<refmeta>
@@ -8,7 +8,7 @@
<refnamediv>
<refname>CREATE CONVERSION</refname>
- <refpurpose>define a new conversion</refpurpose>
+ <refpurpose>define a new encoding conversion</refpurpose>
</refnamediv>
<indexterm zone="sql-createconversion">
@@ -26,10 +26,12 @@ CREATE [DEFAULT] CONVERSION <replaceable>name</replaceable>
<title>Description</title>
<para>
- <command>CREATE CONVERSION</command> defines a new encoding
- conversion. Conversion names may be used in the <function>convert</function> function
+ <command>CREATE CONVERSION</command> defines a new conversion between
+ character set encodings. Conversion names may be used in the
+ <function>convert</function> function
to specify a particular encoding conversion. Also, conversions that
- are marked <literal>DEFAULT</> can be used for automatic encoding conversion between
+ are marked <literal>DEFAULT</> can be used for automatic encoding
+ conversion between
client and server. For this purpose, two conversions, from encoding A to
B <emphasis>and</emphasis> from encoding B to A, must be defined.
</para>
@@ -109,7 +111,7 @@ conv_proc(
integer, -- source encoding ID
integer, -- destination encoding ID
cstring, -- source string (null terminated C string)
- cstring, -- destination string (null terminated C string)
+ internal, -- destination (fill with a null terminated C string)
integer -- source string length
) RETURNS void;
</programlisting>