Changeset 14685

Timestamp:

Mar 21, 2011, 7:34:48 AM (14 years ago)

Author:

R. Matthew Emerson

Message:

Mention that encode-string-to-octets and decode-string-from-octets
will use a replacement character if a character cannot be encoded
or decoded according to the external-format argument.

See ticket:749.

File:

• trunk/source/doc/src/using.xml (modified) (2 diffs)

trunk/source/doc/src/using.xml

@@ -1482 +1482 @@
     <varname>vector</varname> where the decoding ended.
   </para>
+  <para>
+    Sequences of octets in <varname>vector</varname> that cannot be
+    decoded into characters according to
+    <varname>external-format</varname> will be decoded as
+    #\Replacement_Character.
+  </para>
   </refsect1>
 </refentry>
@@ -1532 +1538 @@
     If <varname>vector-offset</varname> is supplied, data will be written
     into the output vector starting at that offset.
+  </para>
+  <para>
+    Characters in <varname>string</varname> that cannot be encoded
+    into <varname>external-format</varname> will be replaced with an
+    encoding-dependent replacement character
+    (#\Replacement_Character or #\Sub) before being encoded and written
+    into the output vector.
   </para>
   </refsect1>