178c2ed229296392f7e55711f4c0f867e6d9eb34
[oweals/openssl.git] / include / internal / o_dir.h
1 /*
2  * Copyright 2004-2016 The OpenSSL Project Authors. All Rights Reserved.
3  *
4  * Licensed under the OpenSSL license (the "License").  You may not use
5  * this file except in compliance with the License.  You can obtain a copy
6  * in the file LICENSE in the source distribution or at
7  * https://www.openssl.org/source/license.html
8  */
9
10 /*
11  * Copied from Richard Levitte's (richard@levitte.org) LP library.  All
12  * symbol names have been changed, with permission from the author.
13  */
14
15 /* $LP: LPlib/source/LPdir.h,v 1.1 2004/06/14 08:56:04 _cvs_levitte Exp $ */
16 /*
17  * Copyright (c) 2004, Richard Levitte <richard@levitte.org>
18  * All rights reserved.
19  *
20  * Redistribution and use in source and binary forms, with or without
21  * modification, are permitted provided that the following conditions
22  * are met:
23  * 1. Redistributions of source code must retain the above copyright
24  *    notice, this list of conditions and the following disclaimer.
25  * 2. Redistributions in binary form must reproduce the above copyright
26  *    notice, this list of conditions and the following disclaimer in the
27  *    documentation and/or other materials provided with the distribution.
28  *
29  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
30  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
31  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
32  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
33  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
34  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
35  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
36  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
37  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
38  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
39  * SUCH DAMAGE.
40  */
41
42 #ifndef O_DIR_H
43 # define O_DIR_H
44
45 #ifdef __cplusplus
46 extern "C" {
47 #endif
48
49 typedef struct OPENSSL_dir_context_st OPENSSL_DIR_CTX;
50
51   /*
52    * returns NULL on error or end-of-directory. If it is end-of-directory,
53    * errno will be zero
54    */
55 const char *OPENSSL_DIR_read(OPENSSL_DIR_CTX **ctx, const char *directory);
56   /* returns 1 on success, 0 on error */
57 int OPENSSL_DIR_end(OPENSSL_DIR_CTX **ctx);
58
59 #ifdef __cplusplus
60 }
61 #endif
62
63 #endif                          /* LPDIR_H */