doc/man/asn1_expand_octet_string.3

   1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
   2 .TH "asn1_expand_octet_string" 3 "2.7" "libtasn1" "libtasn1"
   3 .SH NAME
   4 asn1_expand_octet_string \- API function
   5 .SH SYNOPSIS
   6 .B #include <libtasn1.h>
   7 .sp
   8 .BI "asn1_retCode asn1_expand_octet_string(ASN1_TYPE " definitions ", ASN1_TYPE * " element ", const char * " octetName ", const char * " objectName ");"
   9 .SH ARGUMENTS
  10 .IP "ASN1_TYPE definitions" 12
  11 ASN1 definitions
  12 .IP "ASN1_TYPE * element" 12
  13 pointer to an ASN1 structure
  14 .IP "const char * octetName" 12
  15 name of the OCTECT STRING field to expand.
  16 .IP "const char * objectName" 12
  17 name of the OBJECT IDENTIFIER field to use to define
  18 the type for expansion.
  19 .SH "DESCRIPTION"
  20 Expands an "OCTET STRING" element of a structure created from a DER
  21 decoding process (the \fBasn1_der_decoding()\fP function).  The type used
  22 for expansion is the first one following the definition of the
  23 actual value of the OBJECT IDENTIFIER indicated by OBJECTNAME.
  24 .SH "RETURNS"
  25 \fBASN1_SUCCESS\fP if substitution OK, \fBASN1_ELEMENT_NOT_FOUND\fP
  26 if \fIobjectName\fP or \fIoctetName\fP are not correct,
  27 \fBASN1_VALUE_NOT_VALID\fP if it wasn't possible to find the type to
  28 use for expansion, or other errors depending on DER decoding.
  29 .SH COPYRIGHT
  30 Copyright \(co 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc..
  31 .br
  32 Copying and distribution of this file, with or without modification,
  33 are permitted in any medium without royalty provided the copyright
  34 notice and this notice are preserved.
  35 .SH "SEE ALSO"
  36 The full documentation for
  37 .B libtasn1
  38 is maintained as a Texinfo manual.  If the
  39 .B info
  40 and
  41 .B libtasn1
  42 programs are properly installed at your site, the command
  43 .IP
  44 .B info libtasn1
  45 .PP
  46 should give you access to the complete manual.