Imported Upstream version 4.9
[platform/upstream/libtasn1.git] / doc / man / asn1_get_octet_der.3
1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
2 .TH "asn1_get_octet_der" 3 "4.8" "libtasn1" "libtasn1"
3 .SH NAME
4 asn1_get_octet_der \- API function
5 .SH SYNOPSIS
6 .B #include <libtasn1.h>
7 .sp
8 .BI "int asn1_get_octet_der(const unsigned char * " der ", int " der_len ", int * " ret_len ", unsigned char * " str ", int " str_size ", int * " str_len ");"
9 .SH ARGUMENTS
10 .IP "const unsigned char * der" 12
11 DER data to decode containing the OCTET SEQUENCE.
12 .IP "int der_len" 12
13 The length of the  \fIder\fP data to decode.
14 .IP "int * ret_len" 12
15 Output variable containing the encoded length of the DER data.
16 .IP "unsigned char * str" 12
17 Pre\-allocated output buffer to put decoded OCTET SEQUENCE in.
18 .IP "int str_size" 12
19 Length of pre\-allocated output buffer.
20 .IP "int * str_len" 12
21 Output variable containing the length of the contents of the OCTET SEQUENCE.
22 .SH "DESCRIPTION"
23 Extract an OCTET SEQUENCE from DER data. Note that this function
24 expects the DER data past the tag field, i.e., the length and
25 content octets.
26 .SH "RETURNS"
27 Returns \fBASN1_SUCCESS\fP on success, or an error.
28 .SH COPYRIGHT
29 Copyright \(co 2006-2015 Free Software Foundation, Inc..
30 .br
31 Copying and distribution of this file, with or without modification,
32 are permitted in any medium without royalty provided the copyright
33 notice and this notice are preserved.
34 .SH "SEE ALSO"
35 The full documentation for
36 .B libtasn1
37 is maintained as a Texinfo manual.  If the
38 .B info
39 and
40 .B libtasn1
41 programs are properly installed at your site, the command
42 .IP
43 .B info libtasn1
44 .PP
45 should give you access to the complete manual.
46 As an alternative you may obtain the manual from:
47 .IP
48 .B http://www.gnu.org/software/libtasn1/manual/
49 .PP