~ubuntu-branches/ubuntu/trusty/libtasn1-3/trusty

.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.

.TH "asn1_read_value" 3 "0.3.4" "libtasn1" "libtasn1"

.SH NAME

asn1_read_value \- Returns the value of one element inside a structure

.SH SYNOPSIS

.B #include <libtasn1.h>

.sp

.BI "asn1_retCode asn1_read_value(ASN1_TYPE " root ", const char * " name ", void * " ivalue ", int * " len ");"

.SH ARGUMENTS

.IP "ASN1_TYPE root" 12

pointer to a structure.

.IP "const char * name" 12

the name of the element inside a structure that you want to read.

.IP "void * ivalue" 12

vector that will contain the element's content, must be a

pointer to memory cells already allocated.

.IP "int * len" 12

number of bytes of *value: value[0]..value[len-1]. Initialy

holds the sizeof value.

.SH "DESCRIPTION"

Returns the value of one element inside a structure.

 

If an element is OPTIONAL and the function "read_value" returns

\fBASN1_ELEMENT_NOT_FOUND\fP, it means that this element wasn't present

in the der encoding that created the structure.  The first element

of a SEQUENCE_OF or SET_OF is named "?1". The second one "?2" and

so on.

.SH "INTEGER"

VALUE will contain a two's complement form integer.

 

integer=-1  -> value[0]=0xFF , len=1.

integer=1   -> value[0]=0x01 , len=1.

.SH "ENUMERATED"

As INTEGER (but only with not negative numbers).

.SH "BOOLEAN"

VALUE will be the null terminated string "TRUE" or

"FALSE" and LEN=5 or LEN=6.

.SH "OBJECT IDENTIFIER"

VALUE will be a null terminated string with

each number separated by a dot (i.e. "1.2.3.543.1").

 

LEN = strlen(VALUE)+1

.SH "UTCTIME"

VALUE will be a null terminated string in one of these

formats: "YYMMDDhhmmss+hh'mm'" or "YYMMDDhhmmss-hh'mm'".

LEN=strlen(VALUE)+1.

.SH "GENERALIZEDTIME"

VALUE will be a null terminated string in the

same format used to set the value.

.SH "OCTET STRING"

VALUE will contain the octet string and LEN will be

the number of octets.

.SH "GENERALSTRING"

VALUE will contain the generalstring and LEN will

be the number of octets.

.SH "BIT STRING"

VALUE will contain the bit string organized by bytes

and LEN will be the number of bits.

.SH "CHOICE"

If NAME indicates a choice type, VALUE will specify the

alternative selected.

.SH "ANY"

If NAME indicates an any type, VALUE will indicate the DER

encoding of the structure actually used.

.SH "RETURNS"

.SH "ASN1_SUCCESS"

Set value OK.

.SH "ASN1_ELEMENT_NOT_FOUND"

NAME is not a valid element.

.SH "ASN1_VALUE_NOT_FOUND"

There isn't any value for the element selected.

.SH "ASN1_MEM_ERROR"

The value vector isn't big enough to store the result.

In this case LEN will contain the number of bytes needed.

.SH COPYRIGHT

Copyright \(co 2001, 2002, 2003 Fabio Fiorina.

.br

Permission is granted to make and distribute verbatim copies of this

manual provided the copyright notice and this permission notice are

preserved on all copies.

.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.