Debian Codegraph @

upstream/debian-unstable/man3/OSSL_trace_get_category_num.3ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "OSSL_TRACE_GET_CATEGORY_NUM 3SSL"
58 .TH OSSL_TRACE_GET_CATEGORY_NUM 3SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 OSSL_trace_get_category_num, OSSL_trace_get_category_name
65 \&\- OpenSSL tracing information functions
66 .SH SYNOPSIS
67 .IX Header "SYNOPSIS"
68 .Vb 1
69 \& #include <openssl/trace.h>
70 \&
71 \& int OSSL_trace_get_category_num(const char *name);
72 \& const char *OSSL_trace_get_category_name(int num);
73 .Ve
74 .SH DESCRIPTION
75 .IX Header "DESCRIPTION"
76 \&\fBOSSL_trace_get_category_num()\fR gives the category number corresponding
77 to the given \f(CW\*(C`name\*(C'\fR.
78 .PP
79 \&\fBOSSL_trace_get_category_name()\fR gives the category name corresponding
80 to the given \f(CW\*(C`num\*(C'\fR.
81 .SH "RETURN VALUES"
82 .IX Header "RETURN VALUES"
83 \&\fBOSSL_trace_get_category_num()\fR returns the category number if the given
84 \&\f(CW\*(C`name\*(C'\fR is a recognised category name, otherwise \-1.
85 .PP
86 \&\fBOSSL_trace_get_category_name()\fR returns the category name if the given
87 \&\f(CW\*(C`num\*(C'\fR is a recognised category number, otherwise NULL.
88 .SH HISTORY
89 .IX Header "HISTORY"
90 The OpenSSL Tracing API was added ino OpenSSL 3.0.
91 .SH COPYRIGHT
92 .IX Header "COPYRIGHT"
93 Copyright 2019 The OpenSSL Project Authors. All Rights Reserved.
94 .PP
95 Licensed under the Apache License 2.0 (the "License"). You may not use
96 this file except in compliance with the License. You can obtain a copy
97 in the file LICENSE in the source distribution or at
98 <https://www.openssl.org/source/license.html>.