Initialize Tizen 2.3
[external/libtasn1.git] / doc / man / asn1_der_decoding_startEnd.3
1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
2 .TH "asn1_der_decoding_startEnd" 3 "2.7" "libtasn1" "libtasn1"
3 .SH NAME
4 asn1_der_decoding_startEnd \- API function
5 .SH SYNOPSIS
6 .B #include <libtasn1.h>
7 .sp
8 .BI "asn1_retCode asn1_der_decoding_startEnd(ASN1_TYPE " element ", const void * " ider ", int " len ", const char * " name_element ", int * " start ", int * " end ");"
9 .SH ARGUMENTS
10 .IP "ASN1_TYPE element" 12
11 pointer to an ASN1 element
12 .IP "const void * ider" 12
13 vector that contains the DER encoding.
14 .IP "int len" 12
15 number of bytes of *\fIider\fP: \fIider\fP[0]..\fIider\fP[len\-1]
16 .IP "const char * name_element" 12
17 an element of NAME structure.
18 .IP "int * start" 12
19 the position of the first byte of NAME_ELEMENT decoding
20 (\fIider\fP[*start])
21 .IP "int * end" 12
22 the position of the last byte of NAME_ELEMENT decoding
23 (\fIider\fP[*end])
24 .SH "DESCRIPTION"
25 Find the start and end point of an element in a DER encoding
26 string. I mean that if you have a der encoding and you have already
27 used the function \fBasn1_der_decoding()\fP to fill a structure, it may
28 happen that you want to find the piece of string concerning an
29 element of the structure.
30
31 One example is the sequence "tbsCertificate" inside an X509
32 certificate.
33 .SH "RETURNS"
34 \fBASN1_SUCCESS\fP if DER encoding OK, \fBASN1_ELEMENT_NOT_FOUND\fP
35 if ELEMENT is \fBASN1_TYPE\fP EMPTY or \fIname_element\fP is not a valid
36 element, \fBASN1_TAG_ERROR\fP or \fBASN1_DER_ERROR\fP if the der encoding
37 doesn't match the structure ELEMENT.
38 .SH COPYRIGHT
39 Copyright \(co 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc..
40 .br
41 Copying and distribution of this file, with or without modification,
42 are permitted in any medium without royalty provided the copyright
43 notice and this notice are preserved.
44 .SH "SEE ALSO"
45 The full documentation for
46 .B libtasn1
47 is maintained as a Texinfo manual.  If the
48 .B info
49 and
50 .B libtasn1
51 programs are properly installed at your site, the command
52 .IP
53 .B info libtasn1
54 .PP
55 should give you access to the complete manual.