diff options
Diffstat (limited to 'secure/lib/libcrypto/man/ASN1_STRING_length.3')
| -rw-r--r-- | secure/lib/libcrypto/man/ASN1_STRING_length.3 | 62 |
1 files changed, 33 insertions, 29 deletions
diff --git a/secure/lib/libcrypto/man/ASN1_STRING_length.3 b/secure/lib/libcrypto/man/ASN1_STRING_length.3 index 6d35b461eb487..fc5792b1f1b46 100644 --- a/secure/lib/libcrypto/man/ASN1_STRING_length.3 +++ b/secure/lib/libcrypto/man/ASN1_STRING_length.3 @@ -1,4 +1,4 @@ -.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35) +.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35) .\" .\" Standard preamble: .\" ======================================================================== @@ -54,16 +54,20 @@ .\" Avoid warning from groff about undefined register 'F'. .de IX .. -.if !\nF .nr F 0 -.if \nF>0 \{\ -. de IX -. tm Index:\\$1\t\\n%\t"\\$2" +.nr rF 0 +.if \n(.g .if rF .nr rF 1 +.if (\n(rF:(\n(.g==0)) \{\ +. if \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" .. -. if !\nF==2 \{\ -. nr % 0 -. nr F 2 +. if !\nF==2 \{\ +. nr % 0 +. nr F 2 +. \} . \} .\} +.rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. @@ -129,7 +133,7 @@ .\" ======================================================================== .\" .IX Title "ASN1_STRING_LENGTH 3" -.TH ASN1_STRING_LENGTH 3 "2018-11-20" "1.1.1a" "OpenSSL" +.TH ASN1_STRING_LENGTH 3 "2019-02-26" "1.1.1b" "OpenSSL" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -159,32 +163,32 @@ ASN1_STRING_dup, ASN1_STRING_cmp, ASN1_STRING_set, ASN1_STRING_length, ASN1_STRI .IX Header "DESCRIPTION" These functions allow an \fB\s-1ASN1_STRING\s0\fR structure to be manipulated. .PP -\&\fIASN1_STRING_length()\fR returns the length of the content of \fBx\fR. +\&\fBASN1_STRING_length()\fR returns the length of the content of \fBx\fR. .PP -\&\fIASN1_STRING_get0_data()\fR returns an internal pointer to the data of \fBx\fR. +\&\fBASN1_STRING_get0_data()\fR returns an internal pointer to the data of \fBx\fR. Since this is an internal pointer it should \fBnot\fR be freed or modified in any way. .PP -\&\fIASN1_STRING_data()\fR is similar to \fIASN1_STRING_get0_data()\fR except the +\&\fBASN1_STRING_data()\fR is similar to \fBASN1_STRING_get0_data()\fR except the returned value is not constant. This function is deprecated: -applications should use \fIASN1_STRING_get0_data()\fR instead. +applications should use \fBASN1_STRING_get0_data()\fR instead. .PP -\&\fIASN1_STRING_dup()\fR returns a copy of the structure \fBa\fR. +\&\fBASN1_STRING_dup()\fR returns a copy of the structure \fBa\fR. .PP -\&\fIASN1_STRING_cmp()\fR compares \fBa\fR and \fBb\fR returning 0 if the two +\&\fBASN1_STRING_cmp()\fR compares \fBa\fR and \fBb\fR returning 0 if the two are identical. The string types and content are compared. .PP -\&\fIASN1_STRING_set()\fR sets the data of string \fBstr\fR to the buffer +\&\fBASN1_STRING_set()\fR sets the data of string \fBstr\fR to the buffer \&\fBdata\fR or length \fBlen\fR. The supplied data is copied. If \fBlen\fR is \-1 then the length is determined by strlen(data). .PP -\&\fIASN1_STRING_type()\fR returns the type of \fBx\fR, using standard constants +\&\fBASN1_STRING_type()\fR returns the type of \fBx\fR, using standard constants such as \fBV_ASN1_OCTET_STRING\fR. .PP -\&\fIASN1_STRING_to_UTF8()\fR converts the string \fBin\fR to \s-1UTF8\s0 format, the +\&\fBASN1_STRING_to_UTF8()\fR converts the string \fBin\fR to \s-1UTF8\s0 format, the converted data is allocated in a buffer in \fB*out\fR. The length of \&\fBout\fR is returned or a negative error code. The buffer \fB*out\fR -should be freed using \fIOPENSSL_free()\fR. +should be freed using \fBOPENSSL_free()\fR. .SH "NOTES" .IX Header "NOTES" Almost all \s-1ASN1\s0 types in OpenSSL are represented as an \fB\s-1ASN1_STRING\s0\fR @@ -198,36 +202,36 @@ These functions should \fBnot\fR be used to examine or modify \fB\s-1ASN1_INTEGE or \fB\s-1ASN1_ENUMERATED\s0\fR types: the relevant \fB\s-1INTEGER\s0\fR or \fB\s-1ENUMERATED\s0\fR utility functions should be used instead. .PP -In general it cannot be assumed that the data returned by \fIASN1_STRING_data()\fR +In general it cannot be assumed that the data returned by \fBASN1_STRING_data()\fR is null terminated or does not contain embedded nulls. The actual format of the data will depend on the actual string type itself: for example for an IA5String the data will be \s-1ASCII,\s0 for a BMPString two bytes per character in big endian format, and for an UTF8String it will be in \s-1UTF8\s0 format. .PP Similar care should be take to ensure the data is in the correct format -when calling \fIASN1_STRING_set()\fR. +when calling \fBASN1_STRING_set()\fR. .SH "RETURN VALUES" .IX Header "RETURN VALUES" -\&\fIASN1_STRING_length()\fR returns the length of the content of \fBx\fR. +\&\fBASN1_STRING_length()\fR returns the length of the content of \fBx\fR. .PP -\&\fIASN1_STRING_get0_data()\fR and \fIASN1_STRING_data()\fR return an internal pointer to +\&\fBASN1_STRING_get0_data()\fR and \fBASN1_STRING_data()\fR return an internal pointer to the data of \fBx\fR. .PP -\&\fIASN1_STRING_dup()\fR returns a valid \fB\s-1ASN1_STRING\s0\fR structure or \fB\s-1NULL\s0\fR if an +\&\fBASN1_STRING_dup()\fR returns a valid \fB\s-1ASN1_STRING\s0\fR structure or \fB\s-1NULL\s0\fR if an error occurred. .PP -\&\fIASN1_STRING_cmp()\fR returns an integer greater than, equal to, or less than 0, +\&\fBASN1_STRING_cmp()\fR returns an integer greater than, equal to, or less than 0, according to whether \fBa\fR is greater than, equal to, or less than \fBb\fR. .PP -\&\fIASN1_STRING_set()\fR returns 1 on success or 0 on error. +\&\fBASN1_STRING_set()\fR returns 1 on success or 0 on error. .PP -\&\fIASN1_STRING_type()\fR returns the type of \fBx\fR. +\&\fBASN1_STRING_type()\fR returns the type of \fBx\fR. .PP -\&\fIASN1_STRING_to_UTF8()\fR returns the number of bytes in output string \fBout\fR or a +\&\fBASN1_STRING_to_UTF8()\fR returns the number of bytes in output string \fBout\fR or a negative value if an error occurred. .SH "SEE ALSO" .IX Header "SEE ALSO" -\&\fIERR_get_error\fR\|(3) +\&\fBERR_get_error\fR\|(3) .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright 2002\-2018 The OpenSSL Project Authors. All Rights Reserved. |