SSL_group_to_name.3ossl 2.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697
  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 "SSL_GROUP_TO_NAME 3ossl"
  58. .TH SSL_GROUP_TO_NAME 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. SSL_group_to_name \- get name of group
  65. .SH SYNOPSIS
  66. .IX Header "SYNOPSIS"
  67. .Vb 1
  68. \& #include <openssl/ssl.h>
  69. \&
  70. \& const char *SSL_group_to_name(SSL *ssl, int id);
  71. .Ve
  72. .SH DESCRIPTION
  73. .IX Header "DESCRIPTION"
  74. \&\fBSSL_group_to_name()\fR is used to retrieve the TLS group name
  75. associated with a given TLS group ID, as registered via built-in
  76. or external providers and as returned by a call to \fBSSL_get1_groups()\fR
  77. or \fBSSL_get_shared_group()\fR.
  78. .SH "RETURN VALUES"
  79. .IX Header "RETURN VALUES"
  80. If non-NULL, \fBSSL_group_to_name()\fR returns the TLS group name
  81. corresponding to the given \fIid\fR as a NUL-terminated string.
  82. If \fBSSL_group_to_name()\fR returns NULL, an error occurred; possibly no
  83. corresponding tlsname was registered during provider initialisation.
  84. .PP
  85. Note that the return value is valid only during the lifetime of the
  86. SSL object \fIssl\fR.
  87. .SH "SEE ALSO"
  88. .IX Header "SEE ALSO"
  89. \&\fBssl\fR\|(7)
  90. .SH COPYRIGHT
  91. .IX Header "COPYRIGHT"
  92. Copyright 2021\-2024 The OpenSSL Project Authors. All Rights Reserved.
  93. .PP
  94. Licensed under the Apache License 2.0 (the "License"). You may not use
  95. this file except in compliance with the License. You can obtain a copy
  96. in the file LICENSE in the source distribution or at
  97. <https://www.openssl.org/source/license.html>.