diff options
| author | Anneli Cuss <[email protected]> | 2011-09-07 09:08:59 +1000 |
|---|---|---|
| committer | Henrik Nord <[email protected]> | 2011-09-07 10:56:56 +0200 |
| commit | 292eb1b63dcd8794b468f11cdec55afdbd5c48f6 (patch) | |
| tree | 2f7c98f8c0a5473bfa2c17062dce69a31cdaf9f6 /lib/erl_interface/doc | |
| parent | 22dae863060e0d66fa268f6d1cd4d6f084b850ab (diff) | |
| download | otp-292eb1b63dcd8794b468f11cdec55afdbd5c48f6.tar.gz otp-292eb1b63dcd8794b468f11cdec55afdbd5c48f6.tar.bz2 otp-292eb1b63dcd8794b468f11cdec55afdbd5c48f6.zip | |
ei_decode_ei_term() returns 1 if index is incremented
This documentation is a bit perplexing when viewed in light of
erl_interface/src/misc/ei_decode_term.c.
Diffstat (limited to 'lib/erl_interface/doc')
| -rw-r--r-- | lib/erl_interface/doc/src/ei.xml | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/lib/erl_interface/doc/src/ei.xml b/lib/erl_interface/doc/src/ei.xml index de4e4b4301..76e02a6858 100644 --- a/lib/erl_interface/doc/src/ei.xml +++ b/lib/erl_interface/doc/src/ei.xml @@ -581,9 +581,9 @@ ei_x_encode_empty_list(&x); <c><![CDATA[term]]></c> union, it is decoded, and the appropriate field in <c><![CDATA[term->value]]></c> is set, and <c><![CDATA[*index]]></c> is incremented by the term size.</p> - <p>The function returns 0 on successful decoding, -1 on error, - and 1 if the term seems alright, but does not fit in the - <c><![CDATA[term]]></c> structure. If it returns 0, the <c><![CDATA[index]]></c> + <p>The function returns 1 on successful decoding, -1 on error, + and 0 if the term seems alright, but does not fit in the + <c><![CDATA[term]]></c> structure. If it returns 1, the <c><![CDATA[index]]></c> will be incremented, and the <c><![CDATA[term]]></c> contains the decoded term.</p> <p>The <c><![CDATA[term]]></c> structure will contain the arity for a tuple |