9cf69ddbf87cb412fa671fc842e61808f15d049a
[openssl.git] / doc / man3 / EVP_PKEY_meth_get_count.pod
1 =pod
2
3 =head1 NAME
4
5 EVP_PKEY_meth_get_count, EVP_PKEY_meth_get0, EVP_PKEY_meth_get0_info - enumeratepublic key methods
6
7 =head1 SYNOPSIS
8
9  #include <openssl/evp.h>
10
11  size_t EVP_PKEY_meth_get_count(void);
12  const EVP_PKEY_METHOD *EVP_PKEY_meth_get0(size_t idx);
13  void EVP_PKEY_meth_get0_info(int *ppkey_id, int *pflags,
14                               const EVP_PKEY_METHOD *meth);
15
16 =head1 DESCRIPTION
17
18 EVP_PKEY_meth_count() returns a count of the number of public key methods
19 available: it includes standard methods and any methods added by the
20 application.
21
22 EVP_PKEY_meth_get0() returns the public key method B<idx>. The value of B<idx>
23 must be between zero and EVP_PKEY_meth_get_count() - 1.
24
25 EVP_PKEY_meth_get0_info() returns the public key ID (a NID) and any flags
26 associated with the public key method B<*meth>.
27
28 =head1 RETURN VALUES
29
30 EVP_PKEY_meth_count() returns the number of available public key methods.
31
32 EVP_PKEY_meth_get0() return a public key method or B<NULL> if B<idx> is
33 out of range.
34
35 EVP_PKEY_meth_get0_info() does not return a value.
36
37 =head1 SEE ALSO
38
39 L<EVP_PKEY_new(3)>
40
41 =head1 COPYRIGHT
42
43 Copyright 2002-2016 The OpenSSL Project Authors. All Rights Reserved.
44
45 Licensed under the OpenSSL license (the "License").  You may not use
46 this file except in compliance with the License.  You can obtain a copy
47 in the file LICENSE in the source distribution or at
48 L<https://www.openssl.org/source/license.html>.
49
50 =cut