diff options
Diffstat (limited to 'lib/erl_interface/doc/src/ei.xml')
| -rw-r--r-- | lib/erl_interface/doc/src/ei.xml | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/lib/erl_interface/doc/src/ei.xml b/lib/erl_interface/doc/src/ei.xml index 6d416028a5..9b01f4af98 100644 --- a/lib/erl_interface/doc/src/ei.xml +++ b/lib/erl_interface/doc/src/ei.xml @@ -97,7 +97,7 @@ buffer must be allocated large enough, and for non-compound types the <c><![CDATA[ei_get_type()]]></c> function returns the size required (notice that for strings an - extra byte is needed for the 0 string terminator).</p> + extra byte is needed for the <c>NULL</c>-terminator).</p> </description> <section> @@ -110,14 +110,14 @@ typedef enum { ERLANG_ASCII = 1, ERLANG_LATIN1 = 2, ERLANG_UTF8 = 4 -}erlang_char_encoding;</code> +} erlang_char_encoding;</code> <p>The character encodings used for atoms. <c>ERLANG_ASCII</c> represents 7-bit ASCII. Latin-1 and UTF-8 are different extensions of 7-bit ASCII. All 7-bit ASCII characters are valid Latin-1 and UTF-8 characters. ASCII and Latin-1 both represent each character - by one byte. An UTF-8 character can consist of 1-4 bytes. - Notice that these - constants are bit-flags and can be combined with bitwise OR.</p> + by one byte. An UTF-8 character can consist of 1-4 bytes. + Notice that these constants are bit-flags and can be combined with + bitwise OR.</p> </item> </taglist> </section> @@ -409,7 +409,7 @@ typedef enum { <p>Encodes an atom in the binary format. Parameter <c><![CDATA[p]]></c> is the name of the atom in Latin-1 encoding. Only up to <c>MAXATOMLEN-1</c> bytes - are encoded. The name is to be zero-terminated, except for + are encoded. The name is to be <c>NULL</c>-terminated, except for the <c><![CDATA[ei_x_encode_atom_len()]]></c> function.</p> </desc> </func> @@ -426,7 +426,7 @@ typedef enum { (Latin-1 or UTF-8). Parameter <c>p</c> is the name of the atom with character encoding <seealso marker="#erlang_char_encoding"><c>from_enc</c></seealso> - (ASCII, Latin-1, or UTF-8). The name must either be zero-terminated or + (ASCII, Latin-1, or UTF-8). The name must either be <c>NULL</c>-terminated or a function variant with a <c>len</c> parameter must be used. If <c>to_enc</c> is set to the bitwise OR'd combination <c>(ERLANG_LATIN1|ERLANG_UTF8)</c>, UTF-8 encoding is only used if the @@ -645,7 +645,7 @@ ei_x_encode_string(&x, "Banana");</pre> <desc> <p>Encodes a string in the binary format. (A string in Erlang is a list, but is encoded as a character array in the binary - format.) The string is to be zero-terminated, except for + format.) The string is to be <c>NULL</c>-terminated, except for the <c><![CDATA[ei_x_encode_string_len()]]></c> function.</p> </desc> </func> @@ -731,7 +731,7 @@ ei_encode_tuple_header(buf, &i, 0);</pre> <p>Returns the type in <c><![CDATA[type]]></c> and size in <c><![CDATA[size]]></c> of the encoded term. For strings and atoms, size is the number of characters <em>not</em> including the - terminating 0. For binaries, <c><![CDATA[size]]></c> is the number of + terminating <c>NULL</c>. For binaries, <c><![CDATA[size]]></c> is the number of bytes. For lists and tuples, <c><![CDATA[size]]></c> is the arity of the object. For other types, <c><![CDATA[size]]></c> is 0. In all cases, <c><![CDATA[index]]></c> is left unchanged.</p> @@ -753,7 +753,7 @@ ei_encode_tuple_header(buf, &i, 0);</pre> <c><![CDATA[BUFSIZ]]></c> bytes or a <c>NULL</c> pointer. The string can be reallocated (and <c><![CDATA[*s]]></c> can be updated) by this function if the result is more than <c><![CDATA[BUFSIZ]]></c> - characters. The string returned is zero-terminated.</p> + characters. The string returned is <c>NULL</c>-terminated.</p> <p>The return value is the number of characters written to the file or string, or <c>-1</c> if <c><![CDATA[buf[index]]]></c> does not contain a valid term. |