Correct example.
[openssl.git] / doc / ssl / SSL_set_verify_result.pod
1 =pod
2
3 =head1 NAME
4
5 SSL_set_verify_result - override result of peer certificate verification
6
7 =head1 SYNOPSIS
8
9  #include <openssl/ssl.h>
10
11  void SSL_set_verify_result(SSL *ssl, long verify_result);
12
13 =head1 DESCRIPTION
14
15 SSL_set_verify_result() sets B<verify_result> of the object B<ssl> to be the
16 result of the verification of the X509 certificate presented by the peer,
17 if any.
18
19 =head1 NOTES
20
21 SSL_set_verify_result() overrides the verification result. It only changes
22 the verification result of the B<ssl> object. It does not become part of the
23 established session, so if the session is to be reused later, the original
24 value will reappear.
25
26 The valid codes for B<verify_result> are documented in L<verify(1)|verify(1)>.
27
28 =head1 RETURN VALUES
29
30 SSL_set_verify_result() does not provide a return value.
31
32 =head1 SEE ALSO
33
34 L<ssl(3)|ssl(3)>, L<SSL_get_verify_result(3)|SSL_get_verify_result(3)>,
35 L<SSL_get_peer_certificate(3)|SSL_get_peer_certificate(3)>,
36 L<verify(1)|verify(1)>
37
38 =cut