From cb236e7561d77bf5ef453af284abfabe6790d8a4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B6rn=20Gustavsson?= Date: Fri, 28 Mar 2014 06:51:36 +0100 Subject: Correct description of the undec_rest option The trailing bytes returned are now always a binary. Also condense and clean up the language. --- lib/asn1/doc/src/asn1_ug.xml | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) (limited to 'lib/asn1') diff --git a/lib/asn1/doc/src/asn1_ug.xml b/lib/asn1/doc/src/asn1_ug.xml index 83de80e906..769d15cd02 100644 --- a/lib/asn1/doc/src/asn1_ug.xml +++ b/lib/asn1/doc/src/asn1_ug.xml @@ -298,13 +298,13 @@ erlc -o ../asnfiles -I ../asnfiles -I /usr/local/standards/asn1 Person.asn +undec_rest -

A buffer that holds a message, being decoded may - also have some following bytes. Now it is possible to get - those following bytes returned together with the decoded - value. If an asn1 spec is compiled with this option a tuple - {ok,Value,Rest} is returned. Rest may be a - list or a binary. Earlier versions of the compiler ignored - those following bytes.

+

A buffer that holds a message being decoded may also have + trailing bytes. If those trailing bytes are important they + can be returned along with the decoded value by compiling + the ASN.1 specification with the +undec_rest option. + The return value from the decoder will be + {ok,Value,Rest} where Rest is a binary + containing the trailing bytes.

+'Any Erlc Option' -- cgit v1.2.3