aboutsummaryrefslogtreecommitdiffstats
path: root/lib/erl_interface/doc/src/ei.xml
diff options
context:
space:
mode:
authorRickard Green <[email protected]>2019-02-05 15:55:23 +0100
committerRickard Green <[email protected]>2019-02-05 20:32:45 +0100
commitdbeaca78bc6c0d4719a522e447fa59d7a1006ae0 (patch)
treea88b6e91fc884f826e26a6eb6ffa71c27f0200b3 /lib/erl_interface/doc/src/ei.xml
parent50bf9f5d8403b9903ea63867611ac16ffec1c14c (diff)
downloadotp-dbeaca78bc6c0d4719a522e447fa59d7a1006ae0.tar.gz
otp-dbeaca78bc6c0d4719a522e447fa59d7a1006ae0.tar.bz2
otp-dbeaca78bc6c0d4719a522e447fa59d7a1006ae0.zip
Introduce ei_init()
You previously had to initialize ei via erl_init() which implied that you were forced to link against the erl_interface even when not using it (besides initializing ei).
Diffstat (limited to 'lib/erl_interface/doc/src/ei.xml')
-rw-r--r--lib/erl_interface/doc/src/ei.xml15
1 files changed, 15 insertions, 0 deletions
diff --git a/lib/erl_interface/doc/src/ei.xml b/lib/erl_interface/doc/src/ei.xml
index 9502fb1ee7..a7cbf06085 100644
--- a/lib/erl_interface/doc/src/ei.xml
+++ b/lib/erl_interface/doc/src/ei.xml
@@ -733,6 +733,21 @@ ei_encode_tuple_header(buf, &amp;i, 0);</pre>
</func>
<func>
+ <name><ret>int</ret><nametext>ei_init(void)</nametext></name>
+ <fsummary>Initialize the ei library.</fsummary>
+ <desc>
+ <p>Initialize the <c>ei</c> library. This function should be called once
+ (and only once) before calling any other functionality in the <c>ei</c>
+ library. However, note the exception below.</p>
+ <p>If the <c>ei</c> library is used together with the <c>erl_interface</c>
+ library, this function should <em>not</em> be called directly. It will be
+ called by the <c>erl_init()</c> function which should be used to initialize
+ the combination of the two libraries instead.</p>
+ <p>On success zero is returned. On failure a posix error code is returned.</p>
+ </desc>
+ </func>
+
+ <func>
<name><ret>int</ret><nametext>ei_print_term(FILE* fp, const char* buf, int* index)</nametext></name>
<name><ret>int</ret><nametext>ei_s_print_term(char** s, const char* buf, int* index)</nametext></name>
<fsummary>Print a term in clear text.</fsummary>