doc/man3: reformat the function prototypes in the synopses
[openssl.git] / doc / man3 / o2i_SCT_LIST.pod
1 =pod
2
3 =head1 NAME
4
5 o2i_SCT_LIST, i2o_SCT_LIST, o2i_SCT, i2o_SCT -
6 decode and encode Signed Certificate Timestamp lists in TLS wire format
7
8 =head1 SYNOPSIS
9
10  #include <openssl/ct.h>
11
12  STACK_OF(SCT) *o2i_SCT_LIST(STACK_OF(SCT) **a, const unsigned char **pp,
13                              size_t len);
14  int i2o_SCT_LIST(const STACK_OF(SCT) *a, unsigned char **pp);
15  SCT *o2i_SCT(SCT **psct, const unsigned char **in, size_t len);
16  int i2o_SCT(const SCT *sct, unsigned char **out);
17
18 =head1 DESCRIPTION
19
20 The SCT_LIST and SCT functions are very similar to the i2d and d2i family of
21 functions, except that they convert to and from TLS wire format, as described in
22 RFC 6962. See L<d2i_SCT_LIST> for more information about how the parameters are
23 treated and the return values.
24
25 =head1 RETURN VALUES
26
27 All of the functions have return values consistent with those stated for
28 L<d2i_SCT_LIST> and L<i2d_SCT_LIST>.
29
30 =head1 SEE ALSO
31
32 L<ct(7)>,
33 L<d2i_SCT_LIST(3)>,
34 L<i2d_SCT_LIST(3)>
35
36 =head1 HISTORY
37
38 These functions were added in OpenSSL 1.1.0.
39
40 =head1 COPYRIGHT
41
42 Copyright 2016 The OpenSSL Project Authors. All Rights Reserved.
43
44 Licensed under the OpenSSL license (the "License").  You may not use
45 this file except in compliance with the License.  You can obtain a copy
46 in the file LICENSE in the source distribution or at
47 L<https://www.openssl.org/source/license.html>.
48
49 =cut