doc/man/asn1_der_decoding_element.3

   1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
   2 .TH "asn1_der_decoding_element" 3 "2.7" "libtasn1" "libtasn1"
   3 .SH NAME
   4 asn1_der_decoding_element \- API function
   5 .SH SYNOPSIS
   6 .B #include <libtasn1.h>
   7 .sp
   8 .BI "asn1_retCode asn1_der_decoding_element(ASN1_TYPE * " structure ", const char * " elementName ", const void * " ider ", int " len ", char * " errorDescription ");"
   9 .SH ARGUMENTS
  10 .IP "ASN1_TYPE * structure" 12
  11 pointer to an ASN1 structure
  12 .IP "const char * elementName" 12
  13 name of the element to fill
  14 .IP "const void * ider" 12
  15 vector that contains the DER encoding of the whole structure.
  16 .IP "int len" 12
  17 number of bytes of *der: der[0]..der[len\-1]
  18 .IP "char * errorDescription" 12
  19 null\-terminated string contains details when an
  20 error occurred.
  21 .SH "DESCRIPTION"
  22 Fill the element named \fIELEMENTNAME\fP with values of a DER encoding
  23 string.  The structure must just be created with function
  24 \fBasn1_create_element()\fP.  The DER vector must contain the encoding
  25 string of the whole \fISTRUCTURE\fP.  If an error occurs during the
  26 decoding procedure, the *\fISTRUCTURE\fP is deleted and set equal to
  27 \fBASN1_TYPE_EMPTY\fP.
  28 .SH "RETURNS"
  29 \fBASN1_SUCCESS\fP if DER encoding OK, \fBASN1_ELEMENT_NOT_FOUND\fP
  30 if ELEMENT is \fBASN1_TYPE_EMPTY\fP or \fIelementName\fP == NULL, and
  31 \fBASN1_TAG_ERROR\fP or \fBASN1_DER_ERROR\fP if the der encoding doesn't
  32 match the structure \fIstructure\fP (*ELEMENT deleted).
  33 .SH COPYRIGHT
  34 Copyright \(co 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc..
  35 .br
  36 Copying and distribution of this file, with or without modification,
  37 are permitted in any medium without royalty provided the copyright
  38 notice and this notice are preserved.
  39 .SH "SEE ALSO"
  40 The full documentation for
  41 .B libtasn1
  42 is maintained as a Texinfo manual.  If the
  43 .B info
  44 and
  45 .B libtasn1
  46 programs are properly installed at your site, the command
  47 .IP
  48 .B info libtasn1
  49 .PP
  50 should give you access to the complete manual.