CONF_modules_free.3ossl 3.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113
  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 "CONF_MODULES_FREE 3ossl"
  58. .TH CONF_MODULES_FREE 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. CONF_modules_free, CONF_modules_finish, CONF_modules_unload \-
  65. OpenSSL configuration cleanup functions
  66. .SH SYNOPSIS
  67. .IX Header "SYNOPSIS"
  68. .Vb 1
  69. \& #include <openssl/conf.h>
  70. \&
  71. \& void CONF_modules_finish(void);
  72. \& void CONF_modules_unload(int all);
  73. .Ve
  74. .PP
  75. The following functions have been deprecated since OpenSSL 1.1.0, and can be
  76. hidden entirely by defining \fBOPENSSL_API_COMPAT\fR with a suitable version value,
  77. see \fBopenssl_user_macros\fR\|(7):
  78. .PP
  79. .Vb 1
  80. \& void CONF_modules_free(void);
  81. .Ve
  82. .SH DESCRIPTION
  83. .IX Header "DESCRIPTION"
  84. \&\fBCONF_modules_free()\fR closes down and frees up all memory allocated by all
  85. configuration modules. Normally, in versions of OpenSSL prior to 1.1.0,
  86. applications called
  87. \&\fBCONF_modules_free()\fR at exit to tidy up any configuration performed.
  88. .PP
  89. \&\fBCONF_modules_finish()\fR calls each configuration modules \fBfinish\fR handler
  90. to free up any configuration that module may have performed.
  91. .PP
  92. \&\fBCONF_modules_unload()\fR finishes and unloads configuration modules. If
  93. \&\fBall\fR is set to \fB0\fR only modules loaded from DSOs will be unloads. If
  94. \&\fBall\fR is \fB1\fR all modules, including built-in modules will be unloaded.
  95. .SH "RETURN VALUES"
  96. .IX Header "RETURN VALUES"
  97. None of the functions return a value.
  98. .SH "SEE ALSO"
  99. .IX Header "SEE ALSO"
  100. \&\fBconfig\fR\|(5), \fBOPENSSL_config\fR\|(3),
  101. \&\fBCONF_modules_load_file_ex\fR\|(3)
  102. .SH HISTORY
  103. .IX Header "HISTORY"
  104. \&\fBCONF_modules_free()\fR was deprecated in OpenSSL 1.1.0; do not use it.
  105. For more information see \fBOPENSSL_init_crypto\fR\|(3).
  106. .SH COPYRIGHT
  107. .IX Header "COPYRIGHT"
  108. Copyright 2004\-2020 The OpenSSL Project Authors. All Rights Reserved.
  109. .PP
  110. Licensed under the Apache License 2.0 (the "License"). You may not use
  111. this file except in compliance with the License. You can obtain a copy
  112. in the file LICENSE in the source distribution or at
  113. <https://www.openssl.org/source/license.html>.