summaryrefslogtreecommitdiff
path: root/doc/texi
diff options
context:
space:
mode:
Diffstat (limited to 'doc/texi')
-rw-r--r--doc/texi/ASN1.c.texi4
-rw-r--r--doc/texi/asn1_decode_simple_ber.texi2
-rw-r--r--doc/texi/asn1_der_decoding.texi2
-rw-r--r--doc/texi/asn1_find_node.texi2
-rw-r--r--doc/texi/asn1_get_object_id_der.texi3
-rw-r--r--doc/texi/asn1_get_tag_der.texi2
-rw-r--r--doc/texi/asn1_parser2array.texi2
-rw-r--r--doc/texi/asn1_parser2tree.texi2
-rw-r--r--doc/texi/asn1_read_value.texi5
-rw-r--r--doc/texi/asn1_read_value_type.texi5
-rw-r--r--doc/texi/decoding.c.texi9
-rw-r--r--doc/texi/element.c.texi10
-rw-r--r--doc/texi/parser_aux.c.texi2
13 files changed, 28 insertions, 22 deletions
diff --git a/doc/texi/ASN1.c.texi b/doc/texi/ASN1.c.texi
index 5b6b08a..6c2dc1d 100644
--- a/doc/texi/ASN1.c.texi
+++ b/doc/texi/ASN1.c.texi
@@ -15,7 +15,7 @@ needed to manage the definitions included in @code{file} file.
@strong{Returns:} @code{ASN1_SUCCESS} if the file has a correct syntax and every
identifier is known, @code{ASN1_ELEMENT_NOT_EMPTY} if @code{definitions} not
-@code{NULL} , @code{ASN1_FILE_NOT_FOUND} if an error occured while
+@code{NULL} , @code{ASN1_FILE_NOT_FOUND} if an error occurred while
opening @code{file} , @code{ASN1_SYNTAX_ERROR} if the syntax is not
correct, @code{ASN1_IDENTIFIER_NOT_FOUND} if in the file there is an
identifier that is not defined, @code{ASN1_NAME_TOO_LONG} if in the
@@ -45,7 +45,7 @@ included in @code{inputFileName} file. If @code{inputFileName} is
will be "xx_asn1_tab".
@strong{Returns:} @code{ASN1_SUCCESS} if the file has a correct syntax and every
-identifier is known, @code{ASN1_FILE_NOT_FOUND} if an error occured
+identifier is known, @code{ASN1_FILE_NOT_FOUND} if an error occurred
while opening @code{inputFileName} , @code{ASN1_SYNTAX_ERROR} if the syntax is
not correct, @code{ASN1_IDENTIFIER_NOT_FOUND} if in the file there is
an identifier that is not defined, @code{ASN1_NAME_TOO_LONG} if in the
diff --git a/doc/texi/asn1_decode_simple_ber.texi b/doc/texi/asn1_decode_simple_ber.texi
index c992986..3163a16 100644
--- a/doc/texi/asn1_decode_simple_ber.texi
+++ b/doc/texi/asn1_decode_simple_ber.texi
@@ -13,7 +13,7 @@
@var{ber_len}: the total length occupied by BER (may be @code{NULL} )
-Decodes a BER encoded type. The output is an allocated value
+Decodes a BER encoded type. The output is an allocated value
of the data. This decodes BER STRINGS only. Other types are
decoded as DER.
diff --git a/doc/texi/asn1_der_decoding.texi b/doc/texi/asn1_der_decoding.texi
index ff3574d..ec83535 100644
--- a/doc/texi/asn1_der_decoding.texi
+++ b/doc/texi/asn1_der_decoding.texi
@@ -12,7 +12,7 @@ error occurred.
Fill the structure * @code{element} with values of a DER encoding
string. The structure must just be created with function
-@code{asn1_create_element()} .
+@code{asn1_create_element()} .
Note that the * @code{element} variable is provided as a pointer for
historical reasons.
diff --git a/doc/texi/asn1_find_node.texi b/doc/texi/asn1_find_node.texi
index e5be7c4..9ff06f1 100644
--- a/doc/texi/asn1_find_node.texi
+++ b/doc/texi/asn1_find_node.texi
@@ -6,7 +6,7 @@
@var{name}: null terminated string with the element's name to find.
Searches for an element called @code{name} starting from @code{pointer} . The
-name is composed by differents identifiers separated by dots. When
+name is composed by different identifiers separated by dots. When
* @code{pointer} has a name, the first identifier must be the name of
* @code{pointer} , otherwise it must be the name of one child of * @code{pointer} .
diff --git a/doc/texi/asn1_get_object_id_der.texi b/doc/texi/asn1_get_object_id_der.texi
index a9ef147..8f541e8 100644
--- a/doc/texi/asn1_get_object_id_der.texi
+++ b/doc/texi/asn1_get_object_id_der.texi
@@ -11,7 +11,8 @@
@var{str_size}: Length of pre-allocated output buffer.
-Converts a DER encoded object identifier to its textual form.
+Converts a DER encoded object identifier to its textual form. This
+function expects the DER object identifier without the tag.
@strong{Returns:} @code{ASN1_SUCCESS} on success, or an error.
@end deftypefun
diff --git a/doc/texi/asn1_get_tag_der.texi b/doc/texi/asn1_get_tag_der.texi
index a63ad3b..34fcd54 100644
--- a/doc/texi/asn1_get_tag_der.texi
+++ b/doc/texi/asn1_get_tag_der.texi
@@ -9,7 +9,7 @@
@var{len}: Output variable containing the length of the DER TAG data.
-@var{tag}: Output variable containing the decoded tag.
+@var{tag}: Output variable containing the decoded tag (may be @code{NULL} ).
Decode the class and TAG from DER code.
diff --git a/doc/texi/asn1_parser2array.texi b/doc/texi/asn1_parser2array.texi
index d345e73..84c9012 100644
--- a/doc/texi/asn1_parser2array.texi
+++ b/doc/texi/asn1_parser2array.texi
@@ -20,7 +20,7 @@ included in @code{inputFileName} file. If @code{inputFileName} is
will be "xx_asn1_tab".
@strong{Returns:} @code{ASN1_SUCCESS} if the file has a correct syntax and every
-identifier is known, @code{ASN1_FILE_NOT_FOUND} if an error occured
+identifier is known, @code{ASN1_FILE_NOT_FOUND} if an error occurred
while opening @code{inputFileName} , @code{ASN1_SYNTAX_ERROR} if the syntax is
not correct, @code{ASN1_IDENTIFIER_NOT_FOUND} if in the file there is
an identifier that is not defined, @code{ASN1_NAME_TOO_LONG} if in the
diff --git a/doc/texi/asn1_parser2tree.texi b/doc/texi/asn1_parser2tree.texi
index c545fe6..5087cd2 100644
--- a/doc/texi/asn1_parser2tree.texi
+++ b/doc/texi/asn1_parser2tree.texi
@@ -15,7 +15,7 @@ needed to manage the definitions included in @code{file} file.
@strong{Returns:} @code{ASN1_SUCCESS} if the file has a correct syntax and every
identifier is known, @code{ASN1_ELEMENT_NOT_EMPTY} if @code{definitions} not
-@code{NULL} , @code{ASN1_FILE_NOT_FOUND} if an error occured while
+@code{NULL} , @code{ASN1_FILE_NOT_FOUND} if an error occurred while
opening @code{file} , @code{ASN1_SYNTAX_ERROR} if the syntax is not
correct, @code{ASN1_IDENTIFIER_NOT_FOUND} if in the file there is an
identifier that is not defined, @code{ASN1_NAME_TOO_LONG} if in the
diff --git a/doc/texi/asn1_read_value.texi b/doc/texi/asn1_read_value.texi
index b6bb18c..f1ea8b6 100644
--- a/doc/texi/asn1_read_value.texi
+++ b/doc/texi/asn1_read_value.texi
@@ -11,7 +11,7 @@ pointer to memory cells already allocated (may be @code{NULL} ).
@var{len}: number of bytes of *value: value[0]..value[len-1]. Initialy
holds the sizeof value.
-Returns the value of one element inside a structure.
+Returns the value of one element inside a structure.
If an element is OPTIONAL and this returns
@code{ASN1_ELEMENT_NOT_FOUND} , it means that this element wasn't present
in the der encoding that created the structure. The first element
@@ -65,6 +65,7 @@ encoding of the structure actually used.
@code{ASN1_VALUE_NOT_FOUND} if there isn't any value for the element
selected, and @code{ASN1_MEM_ERROR} if The value vector isn't big enough
to store the result, and in this case @code{len} will contain the number of
-bytes needed.
+bytes needed. On the occasion that the stored data are of zero-length
+this function may return @code{ASN1_SUCCESS} even if the provided @code{len} is zero.
@end deftypefun
diff --git a/doc/texi/asn1_read_value_type.texi b/doc/texi/asn1_read_value_type.texi
index 8f50f4e..9393761 100644
--- a/doc/texi/asn1_read_value_type.texi
+++ b/doc/texi/asn1_read_value_type.texi
@@ -13,7 +13,7 @@ holds the sizeof value.
@var{etype}: The type of the value read (ASN1_ETYPE)
-Returns the type and value of one element inside a structure.
+Returns the type and value of one element inside a structure.
If an element is OPTIONAL and this returns
@code{ASN1_ELEMENT_NOT_FOUND} , it means that this element wasn't present
in the der encoding that created the structure. The first element
@@ -67,6 +67,7 @@ encoding of the structure actually used.
@code{ASN1_VALUE_NOT_FOUND} if there isn't any value for the element
selected, and @code{ASN1_MEM_ERROR} if The value vector isn't big enough
to store the result, and in this case @code{len} will contain the number of
-bytes needed.
+bytes needed. On the occasion that the stored data are of zero-length
+this function may return @code{ASN1_SUCCESS} even if the provided @code{len} is zero.
@end deftypefun
diff --git a/doc/texi/decoding.c.texi b/doc/texi/decoding.c.texi
index b9a3003..2eacc3d 100644
--- a/doc/texi/decoding.c.texi
+++ b/doc/texi/decoding.c.texi
@@ -25,7 +25,7 @@ when the decoded length value plus @code{len} would exceed @code{der_len} .
@var{len}: Output variable containing the length of the DER TAG data.
-@var{tag}: Output variable containing the decoded tag.
+@var{tag}: Output variable containing the decoded tag (may be @code{NULL} ).
Decode the class and TAG from DER code.
@@ -86,7 +86,8 @@ content octets.
@var{str_size}: Length of pre-allocated output buffer.
-Converts a DER encoded object identifier to its textual form.
+Converts a DER encoded object identifier to its textual form. This
+function expects the DER object identifier without the tag.
@strong{Returns:} @code{ASN1_SUCCESS} on success, or an error.
@end deftypefun
@@ -157,7 +158,7 @@ error occurred.
Fill the structure * @code{element} with values of a DER encoding
string. The structure must just be created with function
-@code{asn1_create_element()} .
+@code{asn1_create_element()} .
Note that the * @code{element} variable is provided as a pointer for
historical reasons.
@@ -309,7 +310,7 @@ The output is a pointer inside the @code{der} .
@var{ber_len}: the total length occupied by BER (may be @code{NULL} )
-Decodes a BER encoded type. The output is an allocated value
+Decodes a BER encoded type. The output is an allocated value
of the data. This decodes BER STRINGS only. Other types are
decoded as DER.
diff --git a/doc/texi/element.c.texi b/doc/texi/element.c.texi
index 6e40405..9f793e5 100644
--- a/doc/texi/element.c.texi
+++ b/doc/texi/element.c.texi
@@ -122,7 +122,7 @@ pointer to memory cells already allocated (may be @code{NULL} ).
@var{len}: number of bytes of *value: value[0]..value[len-1]. Initialy
holds the sizeof value.
-Returns the value of one element inside a structure.
+Returns the value of one element inside a structure.
If an element is OPTIONAL and this returns
@code{ASN1_ELEMENT_NOT_FOUND} , it means that this element wasn't present
in the der encoding that created the structure. The first element
@@ -176,7 +176,8 @@ encoding of the structure actually used.
@code{ASN1_VALUE_NOT_FOUND} if there isn't any value for the element
selected, and @code{ASN1_MEM_ERROR} if The value vector isn't big enough
to store the result, and in this case @code{len} will contain the number of
-bytes needed.
+bytes needed. On the occasion that the stored data are of zero-length
+this function may return @code{ASN1_SUCCESS} even if the provided @code{len} is zero.
@end deftypefun
@subheading asn1_read_value_type
@@ -194,7 +195,7 @@ holds the sizeof value.
@var{etype}: The type of the value read (ASN1_ETYPE)
-Returns the type and value of one element inside a structure.
+Returns the type and value of one element inside a structure.
If an element is OPTIONAL and this returns
@code{ASN1_ELEMENT_NOT_FOUND} , it means that this element wasn't present
in the der encoding that created the structure. The first element
@@ -248,7 +249,8 @@ encoding of the structure actually used.
@code{ASN1_VALUE_NOT_FOUND} if there isn't any value for the element
selected, and @code{ASN1_MEM_ERROR} if The value vector isn't big enough
to store the result, and in this case @code{len} will contain the number of
-bytes needed.
+bytes needed. On the occasion that the stored data are of zero-length
+this function may return @code{ASN1_SUCCESS} even if the provided @code{len} is zero.
@end deftypefun
@subheading asn1_read_tag
diff --git a/doc/texi/parser_aux.c.texi b/doc/texi/parser_aux.c.texi
index e5be7c4..9ff06f1 100644
--- a/doc/texi/parser_aux.c.texi
+++ b/doc/texi/parser_aux.c.texi
@@ -6,7 +6,7 @@
@var{name}: null terminated string with the element's name to find.
Searches for an element called @code{name} starting from @code{pointer} . The
-name is composed by differents identifiers separated by dots. When
+name is composed by different identifiers separated by dots. When
* @code{pointer} has a name, the first identifier must be the name of
* @code{pointer} , otherwise it must be the name of one child of * @code{pointer} .
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-22 00:28:29 +0000