aboutsummaryrefslogtreecommitdiffstats
path: root/lib/erl_interface/doc/src/ei.xml
diff options
context:
space:
mode:
authorSverker Eriksson <[email protected]>2013-02-18 15:09:00 +0100
committerSverker Eriksson <[email protected]>2013-02-18 15:20:47 +0100
commit9a35c01873fb56316136e1314ad6adffe97b9fa5 (patch)
treea67f86b77f1e08049b51e766468fb63a139d666e /lib/erl_interface/doc/src/ei.xml
parent499eef0cd693b2f96ec19148d2f6666c3df7d834 (diff)
downloadotp-9a35c01873fb56316136e1314ad6adffe97b9fa5.tar.gz
otp-9a35c01873fb56316136e1314ad6adffe97b9fa5.tar.bz2
otp-9a35c01873fb56316136e1314ad6adffe97b9fa5.zip
erl_interface,ic: Remove node_org_enc from erlang_{pid,port,ref}
in order to be backward compatible with user code that accesses the members of erlang_pid and friend. The documentation does not mention the content of these structs, but we have example code that does. So the safe way it the revert the node_org_enc field (added in R16A) and instead determine in runtime which atom encoding to use depending on if the node atom contains unicode (>255) characters or not.
Diffstat (limited to 'lib/erl_interface/doc/src/ei.xml')
-rw-r--r--lib/erl_interface/doc/src/ei.xml4
1 files changed, 3 insertions, 1 deletions
diff --git a/lib/erl_interface/doc/src/ei.xml b/lib/erl_interface/doc/src/ei.xml
index dfe181bd1d..6c340378d4 100644
--- a/lib/erl_interface/doc/src/ei.xml
+++ b/lib/erl_interface/doc/src/ei.xml
@@ -264,7 +264,9 @@ typedef enum {
The <c>p</c> parameter is the name of the atom with character encoding
<c><seealso marker="#erlang_char_encoding">from_enc</seealso></c> (ascii, latin1 or utf8).
The name must either be zero-terminated or a function variant with a <c>len</c>
- parameter must be used.</p>
+ parameter must be used. If <c>to_enc</c> is set to the bitwise-or'd combination
+ <c>(ERLANG_LATIN1|ERLANG_UTF8)</c>, utf8 encoding is only used if the atom string
+ can not be represented in latin1 encoding.</p>
<p>The encoding will fail if <c>p</c> is not a valid string in encoding <c>from_enc</c>,
if the string is too long or if it can not be represented with character encoding <c>to_enc</c>.</p>
<p>These functions were introduced in R16 release of Erlang/OTP as part of a first step