886d0f155c6e6b12c6455818a073463d4dad5820
[openssl.git] / doc / man3 / OSSL_trace_get_category_num.pod
1 =pod
2
3 =head1 NAME
4
5 OSSL_trace_get_category_num, OSSL_trace_get_category_name
6 - OpenSSL tracing information functions
7
8 =head1 SYNOPSIS
9
10  #include <openssl/trace.h>
11
12  int OSSL_trace_get_category_num(const char *name);
13  const char *OSSL_trace_get_category_name(int num);
14
15 =head1 DESCRIPTION
16
17 OSSL_trace_get_category_num() gives the category number corresponding
18 to the given C<name>.
19
20 OSSL_trace_get_category_name() gives the category name corresponding
21 to the given C<num>.
22
23 =head1 RETURN VALUES
24
25 OSSL_trace_get_category_num() returns the category number if the given
26 C<name> is a recognised category name, otherwise -1.
27
28 OSSL_trace_get_category_name() returns the category name if the given
29 C<num> is a recognised category number, otherwise NULL.
30
31 =head1 HISTORY
32
33 The OpenSSL Tracing API was added ino OpenSSL 3.0.0.
34
35 =head1 COPYRIGHT
36
37 Copyright 2019 The OpenSSL Project Authors. All Rights Reserved.
38
39 Licensed under the Apache License 2.0 (the "License").  You may not use
40 this file except in compliance with the License.  You can obtain a copy
41 in the file LICENSE in the source distribution or at
42 L<https://www.openssl.org/source/license.html>.
43
44 =cut