doc/man3/SSL_group_to_name.pod

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