Update copyright year
[openssl.git] / doc / man3 / OPENSSL_hexchar2int.pod
index 930b32b61f74851ef80d1d9d16c80587016fac6b..9ca57063f879b81ce00db8bfa032333917069570 100644 (file)
@@ -13,10 +13,11 @@ OPENSSL_buf2hexstr_ex, OPENSSL_buf2hexstr
 
  int OPENSSL_hexchar2int(unsigned char c);
  int OPENSSL_hexstr2buf_ex(unsigned char *buf, size_t buf_n, long *buflen,
-                           const char *str);
+                           const char *str, const char sep);
  unsigned char *OPENSSL_hexstr2buf(const char *str, long *len);
- int OPENSSL_buf2hexstr_ex(char *str, size_t str_n, size_t *strlen,
-                           const unsigned char *buf, long buflen);
+ int OPENSSL_buf2hexstr_ex(char *str, size_t str_n, size_t *strlength,
+                           const unsigned char *buf, long buflen,
+                           const char sep);
  char *OPENSSL_buf2hexstr(const unsigned char *buf, long buflen);
 
 =head1 DESCRIPTION
@@ -26,6 +27,8 @@ equivalent.
 
 OPENSSL_hexstr2buf_ex() decodes the hex string B<str> and places the
 resulting string of bytes in the given I<buf>.
+The character I<sep> is the separator between the bytes, setting this to '\0'
+means that there is no separator.
 I<buf_n> gives the size of the buffer.
 If I<buflen> is not NULL, it is filled in with the result length.
 To find out how large the result will be, call this function with NULL
@@ -34,20 +37,24 @@ Colons between two-character hex "bytes" are accepted and ignored.
 An odd number of hex digits is an error.
 
 OPENSSL_hexstr2buf() does the same thing as OPENSSL_hexstr2buf_ex(),
-but allocates the space for the result, and returns the result.
+but allocates the space for the result, and returns the result. It uses a
+default separator of ':'.
 The memory is allocated by calling OPENSSL_malloc() and should be
 released by calling OPENSSL_free().
 
 OPENSSL_buf2hexstr_ex() encodes the contents of the given I<buf> with
 length I<buflen> and places the resulting hexadecimal character string
 in the given I<str>.
+The character I<sep> is the separator between the bytes, setting this to '\0'
+means that there is no separator.
 I<str_n> gives the size of the of the string buffer.
-If I<strlen> is not NULL, it is filled in with the result length.
+If I<strlength> is not NULL, it is filled in with the result length.
 To find out how large the result will be, call this function with NULL
 for I<str>.
 
 OPENSSL_buf2hexstr() does the same thing as OPENSSL_buf2hexstr_ex(),
-but allocates the space for the result, and returns the result.
+but allocates the space for the result, and returns the result. It uses a
+default separator of ':'.
 The memory is allocated by calling OPENSSL_malloc() and should be
 released by calling OPENSSL_free().
 
@@ -64,7 +71,7 @@ success, or 0 on error.
 
 =head1 COPYRIGHT
 
-Copyright 2016-2019 The OpenSSL Project Authors. All Rights Reserved.
+Copyright 2016-2022 The OpenSSL Project Authors. All Rights Reserved.
 
 Licensed under the Apache License 2.0 (the "License").  You may not use
 this file except in compliance with the License.  You can obtain a copy