[thirdparty/openssl.git] / doc / man3 / X509_STORE_new.pod

=pod

=head1 NAME

X509_STORE_new, X509_STORE_up_ref, X509_STORE_free, X509_STORE_lock,
X509_STORE_unlock - X509_STORE allocation, freeing and locking functions

=head1 SYNOPSIS

 #include <openssl/x509_vfy.h>

 X509_STORE *X509_STORE_new(void);
 void X509_STORE_free(X509_STORE *v);
 int X509_STORE_lock(X509_STORE *v);
 int X509_STORE_unlock(X509_STORE *v);
 int X509_STORE_up_ref(X509_STORE *v);

=head1 DESCRIPTION

The X509_STORE_new() function returns a new X509_STORE.

X509_STORE_up_ref() increments the reference count associated with the
X509_STORE object.

X509_STORE_lock() locks the store from modification by other threads,
X509_STORE_unlock() locks it.

X509_STORE_free() frees up a single X509_STORE object.

=head1 RETURN VALUES

X509_STORE_new() returns a newly created X509_STORE or NULL if the call fails.

X509_STORE_up_ref(), X509_STORE_lock() and X509_STORE_unlock() return
1 for success and 0 for failure.

X509_STORE_free() does not return values.

=head1 SEE ALSO

L<X509_STORE_set_verify_cb_func(3)>
L<X509_STORE_get0_param(3)>

=head1 HISTORY

The X509_STORE_up_ref(), X509_STORE_lock() and X509_STORE_unlock()
functions were added in OpenSSL 1.1.0

=head1 COPYRIGHT

Copyright 2016 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the "License").  You may not use
this file except in compliance with the License.  You can obtain a copy
in the file LICENSE in the source distribution or at
L<https://www.openssl.org/source/license.html>.

=cut
Commit	Line	Data
c001ce33 AG	1	=pod
	2
	3	=head1 NAME
	4
3067095e RL	5	X509_STORE_new, X509_STORE_up_ref, X509_STORE_free, X509_STORE_lock,
3067095e RL	6	X509_STORE_unlock - X509_STORE allocation, freeing and locking functions
c001ce33 AG	7
	8	=head1 SYNOPSIS
	9
	10	#include <openssl/x509_vfy.h>
	11
	12	X509_STORE *X509_STORE_new(void);
	13	void X509_STORE_free(X509_STORE *v);
3067095e RL	14	int X509_STORE_lock(X509_STORE *v);
3067095e RL	15	int X509_STORE_unlock(X509_STORE *v);
c001ce33 AG	16	int X509_STORE_up_ref(X509_STORE *v);
	17
	18	=head1 DESCRIPTION
	19
	20	The X509_STORE_new() function returns a new X509_STORE.
	21
	22	X509_STORE_up_ref() increments the reference count associated with the
	23	X509_STORE object.
	24
3067095e RL	25	X509_STORE_lock() locks the store from modification by other threads,
	26	X509_STORE_unlock() locks it.
	27
c001ce33 AG	28	X509_STORE_free() frees up a single X509_STORE object.
	29
	30	=head1 RETURN VALUES
	31
	32	X509_STORE_new() returns a newly created X509_STORE or NULL if the call fails.
	33
3067095e RL	34	X509_STORE_up_ref(), X509_STORE_lock() and X509_STORE_unlock() return
3067095e RL	35	1 for success and 0 for failure.
c001ce33 AG	36
	37	X509_STORE_free() does not return values.
	38
	39	=head1 SEE ALSO
	40
	41	L<X509_STORE_set_verify_cb_func(3)>
f0c58c32 CH	42	L<X509_STORE_get0_param(3)>
	43
	44	=head1 HISTORY
	45
3067095e RL	46	The X509_STORE_up_ref(), X509_STORE_lock() and X509_STORE_unlock()
3067095e RL	47	functions were added in OpenSSL 1.1.0
c001ce33	48
e2f92610 RS	49	=head1 COPYRIGHT
	50
	51	Copyright 2016 The OpenSSL Project Authors. All Rights Reserved.
	52
4746f25a	53	Licensed under the Apache License 2.0 (the "License"). You may not use
e2f92610 RS	54	this file except in compliance with the License. You can obtain a copy
	55	in the file LICENSE in the source distribution or at
	56	L<https://www.openssl.org/source/license.html>.
	57
	58	=cut