summaryrefslogtreecommitdiff
path: root/doc/texi/decoding.c.texi
diff options
context:
space:
mode:
Diffstat (limited to 'doc/texi/decoding.c.texi')
-rw-r--r--doc/texi/decoding.c.texi10
1 files changed, 6 insertions, 4 deletions
diff --git a/doc/texi/decoding.c.texi b/doc/texi/decoding.c.texi
index 7c04d30..b9a3003 100644
--- a/doc/texi/decoding.c.texi
+++ b/doc/texi/decoding.c.texi
@@ -56,17 +56,19 @@ the value was too big.
@deftypefun {int} {asn1_get_octet_der} (const unsigned char * @var{der}, int @var{der_len}, int * @var{ret_len}, unsigned char * @var{str}, int @var{str_size}, int * @var{str_len})
@var{der}: DER data to decode containing the OCTET SEQUENCE.
-@var{der_len}: Length of DER data to decode.
+@var{der_len}: The length of the @code{der} data to decode.
-@var{ret_len}: Output variable containing the length of the DER data.
+@var{ret_len}: Output variable containing the encoded length of the DER data.
@var{str}: Pre-allocated output buffer to put decoded OCTET SEQUENCE in.
@var{str_size}: Length of pre-allocated output buffer.
-@var{str_len}: Output variable containing the length of the OCTET SEQUENCE.
+@var{str_len}: Output variable containing the length of the contents of the OCTET SEQUENCE.
-Extract an OCTET SEQUENCE from DER data.
+Extract an OCTET SEQUENCE from DER data. Note that this function
+expects the DER data past the tag field, i.e., the length and
+content octets.
@strong{Returns:} Returns @code{ASN1_SUCCESS} on success, or an error.
@end deftypefun