summaryrefslogtreecommitdiffstats
path: root/doc/man3/ASN1_STRING_length.pod
diff options
context:
space:
mode:
authorRichard Levitte <levitte@openssl.org>2019-09-28 08:07:18 +0200
committerRichard Levitte <levitte@openssl.org>2019-10-01 22:31:30 +0200
commit723e9c8983f92bc256a7e8677cc02f05b47e227c (patch)
treef3fef2a633b61bfc9f2d6c1244bfe77556ecaacc /doc/man3/ASN1_STRING_length.pod
parente8769719c9bbe53d7af088111b7625671660d4db (diff)
Make ASN1 manuals conform with man-pages(7)
Details from man-pages(7) that are used: Formatting conventions for manual pages describing functions ... Variable names should, like argument names, be specified in italics. ... Formatting conventions (general) ... Special macros, which are usually in uppercase, are in bold. Exception: don't boldface NULL. ... Reviewed-by: Matt Caswell <matt@openssl.org> (Merged from https://github.com/openssl/openssl/pull/10042)
Diffstat (limited to 'doc/man3/ASN1_STRING_length.pod')
-rw-r--r--doc/man3/ASN1_STRING_length.pod32
1 files changed, 16 insertions, 16 deletions
diff --git a/doc/man3/ASN1_STRING_length.pod b/doc/man3/ASN1_STRING_length.pod
index 86eb835010..ae03dd9737 100644
--- a/doc/man3/ASN1_STRING_length.pod
+++ b/doc/man3/ASN1_STRING_length.pod
@@ -28,9 +28,9 @@ ASN1_STRING_to_UTF8 - ASN1_STRING utility functions
These functions allow an B<ASN1_STRING> structure to be manipulated.
-ASN1_STRING_length() returns the length of the content of B<x>.
+ASN1_STRING_length() returns the length of the content of I<x>.
-ASN1_STRING_get0_data() returns an internal pointer to the data of B<x>.
+ASN1_STRING_get0_data() returns an internal pointer to the data of I<x>.
Since this is an internal pointer it should B<not> be freed or
modified in any way.
@@ -38,21 +38,21 @@ ASN1_STRING_data() is similar to ASN1_STRING_get0_data() except the
returned value is not constant. This function is deprecated:
applications should use ASN1_STRING_get0_data() instead.
-ASN1_STRING_dup() returns a copy of the structure B<a>.
+ASN1_STRING_dup() returns a copy of the structure I<a>.
-ASN1_STRING_cmp() compares B<a> and B<b> returning 0 if the two
+ASN1_STRING_cmp() compares I<a> and I<b> returning 0 if the two
are identical. The string types and content are compared.
-ASN1_STRING_set() sets the data of string B<str> to the buffer
-B<data> or length B<len>. The supplied data is copied. If B<len>
+ASN1_STRING_set() sets the data of string I<str> to the buffer
+I<data> or length I<len>. The supplied data is copied. If I<len>
is -1 then the length is determined by strlen(data).
-ASN1_STRING_type() returns the type of B<x>, using standard constants
+ASN1_STRING_type() returns the type of I<x>, using standard constants
such as B<V_ASN1_OCTET_STRING>.
-ASN1_STRING_to_UTF8() converts the string B<in> to UTF8 format, the
-converted data is allocated in a buffer in B<*out>. The length of
-B<out> is returned or a negative error code. The buffer B<*out>
+ASN1_STRING_to_UTF8() converts the string I<in> to UTF8 format, the
+converted data is allocated in a buffer in I<*out>. The length of
+I<out> is returned or a negative error code. The buffer I<*out>
should be freed using OPENSSL_free().
=head1 NOTES
@@ -79,22 +79,22 @@ when calling ASN1_STRING_set().
=head1 RETURN VALUES
-ASN1_STRING_length() returns the length of the content of B<x>.
+ASN1_STRING_length() returns the length of the content of I<x>.
ASN1_STRING_get0_data() and ASN1_STRING_data() return an internal pointer to
-the data of B<x>.
+the data of I<x>.
-ASN1_STRING_dup() returns a valid B<ASN1_STRING> structure or B<NULL> if an
+ASN1_STRING_dup() returns a valid B<ASN1_STRING> structure or NULL if an
error occurred.
ASN1_STRING_cmp() returns an integer greater than, equal to, or less than 0,
-according to whether B<a> is greater than, equal to, or less than B<b>.
+according to whether I<a> is greater than, equal to, or less than I<b>.
ASN1_STRING_set() returns 1 on success or 0 on error.
-ASN1_STRING_type() returns the type of B<x>.
+ASN1_STRING_type() returns the type of I<x>.
-ASN1_STRING_to_UTF8() returns the number of bytes in output string B<out> or a
+ASN1_STRING_to_UTF8() returns the number of bytes in output string I<out> or a
negative value if an error occurred.
=head1 SEE ALSO