xref: /netbsd-src/crypto/external/bsd/openssl/lib/libcrypto/man/EVP_PKEY_get_group_name.3 (revision 7d9ffdb3e9da593a05c5e2169f72fc7bada08bc9)
$NetBSD: EVP_PKEY_get_group_name.3,v 1.5 2024/09/08 13:08:23 christos Exp $

-*- mode: troff; coding: utf-8 -*-
Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)

Standard preamble:
========================================================================
..
..
.. \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
. ds C` "" . ds C' "" 'br\} . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF ========================================================================

Title "EVP_PKEY_get_group_name 3"
EVP_PKEY_get_group_name 3 2024-09-03 3.0.15 OpenSSL
For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
NAME
EVP_PKEY_get_group_name - get group name of a key
SYNOPSIS
Header "SYNOPSIS" .Vb 1 #include <openssl/evp.h> \& int EVP_PKEY_get_group_name(EVP_PKEY *pkey, char *gname, size_t gname_sz, size_t *gname_len); .Ve
DESCRIPTION
Header "DESCRIPTION" \fBEVP_PKEY_get_group_name() fills in the group name of the pkey into \fIgname, up to at most gname_sz bytes including the ending NUL byte and assigns *gname_len the actual length of the name not including the NUL byte, if pkey's key type supports it. \fIgname as well as gname_len may individually be NULL, and won't be filled in or assigned in that case.
NOTES
Header "NOTES" Among the standard OpenSSL key types, this is only supported for DH, EC and SM2 keys. Other providers may support this for additional key types.
"RETURN VALUES"
Header "RETURN VALUES" \fBEVP_PKEY_get_group_name() returns 1 if the group name could be filled in, otherwise 0.
HISTORY
Header "HISTORY" This function was added in OpenSSL 3.0.
COPYRIGHT
Header "COPYRIGHT" Copyright 2020-2021 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>.