diff options
author | Rickard Green <[email protected]> | 2019-02-06 16:02:04 +0100 |
---|---|---|
committer | Rickard Green <[email protected]> | 2019-02-06 16:02:04 +0100 |
commit | 2a1dab38c8a2186a7413eabb2035234cb66f367f (patch) | |
tree | 74152f431d68ca679eb1156e98136e53249b7d87 /lib/erl_interface/doc/src/ei.xml | |
parent | b01083b47699f0494053abfbe7ae1f50142b1b49 (diff) | |
parent | 320a02e522085fe5eec141d7bf18631e4ef74f0a (diff) | |
download | otp-2a1dab38c8a2186a7413eabb2035234cb66f367f.tar.gz otp-2a1dab38c8a2186a7413eabb2035234cb66f367f.tar.bz2 otp-2a1dab38c8a2186a7413eabb2035234cb66f367f.zip |
Merge branch 'rickard/ei-ext-maint/OTP-15442' into maint
* rickard/ei-ext-maint/OTP-15442:
Introduce ei_init()
Fix bug in ei_accept_tmo
Fix build of erl_interface on BSD
Diffstat (limited to 'lib/erl_interface/doc/src/ei.xml')
-rw-r--r-- | lib/erl_interface/doc/src/ei.xml | 15 |
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 16f4e18637..ae322255ad 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, &i, 0);</pre> </func> <func> + <name since="OTP @OTP-15442@"><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 since=""><ret>int</ret><nametext>ei_print_term(FILE* fp, const char* buf, int* index)</nametext></name> <name since=""><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> |