Imported Upstream version 4.8
[platform/upstream/libtasn1.git] / doc / texi / asn1_parser2tree.texi
1 @subheading asn1_parser2tree
2 @anchor{asn1_parser2tree}
3 @deftypefun {int} {asn1_parser2tree} (const char * @var{file}, asn1_node * @var{definitions}, char * @var{error_desc})
4 @var{file}: specify the path and the name of file that contains
5 ASN.1 declarations.
6
7 @var{definitions}: return the pointer to the structure created from
8 "file" ASN.1 declarations.
9
10 @var{error_desc}: return the error description or an empty
11 string if success.
12
13 Function used to start the parse algorithm.  Creates the structures
14 needed to manage the definitions included in  @code{file} file.
15
16 @strong{Returns:} @code{ASN1_SUCCESS}  if the file has a correct syntax and every
17 identifier is known, @code{ASN1_ELEMENT_NOT_EMPTY}  if  @code{definitions} not
18 @code{NULL} , @code{ASN1_FILE_NOT_FOUND}  if an error occured while
19 opening  @code{file} , @code{ASN1_SYNTAX_ERROR}  if the syntax is not
20 correct, @code{ASN1_IDENTIFIER_NOT_FOUND}  if in the file there is an
21 identifier that is not defined, @code{ASN1_NAME_TOO_LONG}  if in the
22 file there is an identifier whith more than @code{ASN1_MAX_NAME_SIZE} 
23 characters.
24 @end deftypefun
25