ERR_load_crypto_strings.3ossl 3.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109
  1. .\" -*- mode: troff; coding: utf-8 -*-
  2. .\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
  3. .\"
  4. .\" Standard preamble:
  5. .\" ========================================================================
  6. .de Sp \" Vertical space (when we can't use .PP)
  7. .if t .sp .5v
  8. .if n .sp
  9. ..
  10. .de Vb \" Begin verbatim text
  11. .ft CW
  12. .nf
  13. .ne \\$1
  14. ..
  15. .de Ve \" End verbatim text
  16. .ft R
  17. .fi
  18. ..
  19. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
  20. .ie n \{\
  21. . ds C` ""
  22. . ds C' ""
  23. 'br\}
  24. .el\{\
  25. . ds C`
  26. . ds C'
  27. 'br\}
  28. .\"
  29. .\" Escape single quotes in literal strings from groff's Unicode transform.
  30. .ie \n(.g .ds Aq \(aq
  31. .el .ds Aq '
  32. .\"
  33. .\" If the F register is >0, we'll generate index entries on stderr for
  34. .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  35. .\" entries marked with X<> in POD. Of course, you'll have to process the
  36. .\" output yourself in some meaningful fashion.
  37. .\"
  38. .\" Avoid warning from groff about undefined register 'F'.
  39. .de IX
  40. ..
  41. .nr rF 0
  42. .if \n(.g .if rF .nr rF 1
  43. .if (\n(rF:(\n(.g==0)) \{\
  44. . if \nF \{\
  45. . de IX
  46. . tm Index:\\$1\t\\n%\t"\\$2"
  47. ..
  48. . if !\nF==2 \{\
  49. . nr % 0
  50. . nr F 2
  51. . \}
  52. . \}
  53. .\}
  54. .rr rF
  55. .\" ========================================================================
  56. .\"
  57. .IX Title "ERR_LOAD_CRYPTO_STRINGS 3ossl"
  58. .TH ERR_LOAD_CRYPTO_STRINGS 3ossl 2025-01-17 3.4.0 OpenSSL
  59. .\" For nroff, turn off justification. Always turn off hyphenation; it makes
  60. .\" way too many mistakes in technical documents.
  61. .if n .ad l
  62. .nh
  63. .SH NAME
  64. ERR_load_crypto_strings, SSL_load_error_strings, ERR_free_strings \-
  65. load and free error strings
  66. .SH SYNOPSIS
  67. .IX Header "SYNOPSIS"
  68. The following functions have been deprecated since OpenSSL 1.1.0, and can be
  69. hidden entirely by defining \fBOPENSSL_API_COMPAT\fR with a suitable version value,
  70. see \fBopenssl_user_macros\fR\|(7):
  71. .PP
  72. .Vb 1
  73. \& #include <openssl/err.h>
  74. \&
  75. \& void ERR_load_crypto_strings(void);
  76. \& void ERR_free_strings(void);
  77. \&
  78. \& #include <openssl/ssl.h>
  79. \&
  80. \& void SSL_load_error_strings(void);
  81. .Ve
  82. .SH DESCRIPTION
  83. .IX Header "DESCRIPTION"
  84. \&\fBERR_load_crypto_strings()\fR registers the error strings for all
  85. \&\fBlibcrypto\fR functions. \fBSSL_load_error_strings()\fR does the same,
  86. but also registers the \fBlibssl\fR error strings.
  87. .PP
  88. In versions prior to OpenSSL 1.1.0,
  89. \&\fBERR_free_strings()\fR releases any resources created by the above functions.
  90. .SH "RETURN VALUES"
  91. .IX Header "RETURN VALUES"
  92. \&\fBERR_load_crypto_strings()\fR, \fBSSL_load_error_strings()\fR and
  93. \&\fBERR_free_strings()\fR return no values.
  94. .SH "SEE ALSO"
  95. .IX Header "SEE ALSO"
  96. \&\fBERR_error_string\fR\|(3)
  97. .SH HISTORY
  98. .IX Header "HISTORY"
  99. The \fBERR_load_crypto_strings()\fR, \fBSSL_load_error_strings()\fR, and
  100. \&\fBERR_free_strings()\fR functions were deprecated in OpenSSL 1.1.0 by
  101. \&\fBOPENSSL_init_crypto()\fR and \fBOPENSSL_init_ssl()\fR and should not be used.
  102. .SH COPYRIGHT
  103. .IX Header "COPYRIGHT"
  104. Copyright 2000\-2017 The OpenSSL Project Authors. All Rights Reserved.
  105. .PP
  106. Licensed under the Apache License 2.0 (the "License"). You may not use
  107. this file except in compliance with the License. You can obtain a copy
  108. in the file LICENSE in the source distribution or at
  109. <https://www.openssl.org/source/license.html>.