summaryrefslogtreecommitdiff
path: root/doc/man/asn1_parser2array.3
blob: 0b718b6ef887ed3798d338e64c9fa2dba0cdd358 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
.TH "asn1_parser2array" 3 "4.13" "libtasn1" "libtasn1"
.SH NAME
asn1_parser2array \- API function
.SH SYNOPSIS
.B #include <libtasn1.h>
.sp
.BI "int asn1_parser2array(const char * " inputFileName ", const char * " outputFileName ", const char * " vectorName ", char * " error_desc ");"
.SH ARGUMENTS
.IP "const char * inputFileName" 12
specify the path and the name of file that
contains ASN.1 declarations.
.IP "const char * outputFileName" 12
specify the path and the name of file that will
contain the C vector definition.
.IP "const char * vectorName" 12
specify the name of the C vector.
.IP "char * error_desc" 12
return the error description or an empty
string if success.
.SH "DESCRIPTION"
Function that generates a C structure from an ASN1 file.  Creates a
file containing a C vector to use to manage the definitions
included in  \fIinputFileName\fP file. If  \fIinputFileName\fP is
"/aa/bb/xx.yy" and  \fIoutputFileName\fP is \fBNULL\fP, the file created is
"/aa/bb/xx_asn1_tab.c".  If  \fIvectorName\fP is \fBNULL\fP the vector name
will be "xx_asn1_tab".
.SH "RETURNS"
\fBASN1_SUCCESS\fP if the file has a correct syntax and every
identifier is known, \fBASN1_FILE_NOT_FOUND\fP if an error occurred
while opening  \fIinputFileName\fP , \fBASN1_SYNTAX_ERROR\fP if the syntax is
not correct, \fBASN1_IDENTIFIER_NOT_FOUND\fP if in the file there is
an identifier that is not defined, \fBASN1_NAME_TOO_LONG\fP if in the
file there is an identifier whith more than \fBASN1_MAX_NAME_SIZE\fP
characters.
.SH COPYRIGHT
Copyright \(co 2006-2015 Free Software Foundation, Inc..
.br
Copying and distribution of this file, with or without modification,
are permitted in any medium without royalty provided the copyright
notice and this notice are preserved.
.SH "SEE ALSO"
The full documentation for
.B libtasn1
is maintained as a Texinfo manual.  If the
.B info
and
.B libtasn1
programs are properly installed at your site, the command
.IP
.B info libtasn1
.PP
should give you access to the complete manual.
As an alternative you may obtain the manual from:
.IP
.B http://www.gnu.org/software/libtasn1/manual/
.PP