SSL_group_to_name.pod 1.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243
  1. =pod
  2. =head1 NAME
  3. SSL_group_to_name - get name of group
  4. =head1 SYNOPSIS
  5. #include <openssl/ssl.h>
  6. const char *SSL_group_to_name(const SSL *ssl, int id);
  7. =head1 DESCRIPTION
  8. SSL_group_to_name() is used to retrieve the TLS group name
  9. associated with a given TLS group ID, as registered via built-in
  10. or external providers and as returned by a call to SSL_get1_groups()
  11. or SSL_get_shared_group().
  12. =head1 RETURN VALUES
  13. If non-NULL, SSL_group_to_name() returns the TLS group name
  14. corresponding to the given I<id> as a NUL-terminated string.
  15. If SSL_group_to_name() returns NULL, an error occurred; possibly no
  16. corresponding tlsname was registered during provider initialisation.
  17. Note that the return value is valid only during the lifetime of the
  18. SSL object I<ssl>.
  19. =head1 SEE ALSO
  20. L<ssl(7)>
  21. =head1 COPYRIGHT
  22. Copyright 2021 The OpenSSL Project Authors. All Rights Reserved.
  23. Licensed under the Apache License 2.0 (the "License"). You may not use
  24. this file except in compliance with the License. You can obtain a copy
  25. in the file LICENSE in the source distribution or at
  26. L<https://www.openssl.org/source/license.html>.
  27. =cut