summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNikos Mavrogiannopoulos <nmav@redhat.com>2016-04-07 15:23:09 +0200
committerNikos Mavrogiannopoulos <nmav@redhat.com>2016-04-07 18:57:38 +0200
commit45e02558981f053338e57d103c705fd533c35dbc (patch)
tree0c63743ec43f88fbe6b18f5adccb10c73b19eeff
parent39465cb227a122d99dc39be47aadd758980c36b5 (diff)
downloadlibtasn1-45e02558981f053338e57d103c705fd533c35dbc.tar.gz
asn1_get_octet_der: doc update
-rw-r--r--lib/decoding.c10
1 files changed, 6 insertions, 4 deletions
diff --git a/lib/decoding.c b/lib/decoding.c
index 4fff03e..2b2faf6 100644
--- a/lib/decoding.c
+++ b/lib/decoding.c
@@ -236,13 +236,15 @@ asn1_get_length_ber (const unsigned char *ber, int ber_len, int *len)
/**
* asn1_get_octet_der:
* @der: DER data to decode containing the OCTET SEQUENCE.
- * @der_len: Length of DER data to decode.
- * @ret_len: Output variable containing the length of the DER data.
+ * @der_len: The length of the @der data to decode.
+ * @ret_len: Output variable containing the encoded length of the DER data.
* @str: Pre-allocated output buffer to put decoded OCTET SEQUENCE in.
* @str_size: Length of pre-allocated output buffer.
- * @str_len: Output variable containing the length of the OCTET SEQUENCE.
+ * @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.
*
* Returns: Returns %ASN1_SUCCESS on success, or an error.
**/