From Ivan Lawrow: Added IEEE 802.15.4-2003 AES-CCM security modes
[obnox/wireshark/wip.git] / tempfile.h
1 /* tempfile.h
2  * Declarations of routines to create temporary files
3  *
4  * $Id$
5  *
6  * Wireshark - Network traffic analyzer
7  * By Gerald Combs <gerald@wireshark.org>
8  * Copyright 1998 Gerald Combs
9  *
10  * This program is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU General Public License
12  * as published by the Free Software Foundation; either version 2
13  * of the License, or (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
23  */
24
25 #ifndef __TEMPFILE_H__
26 #define __TEMPFILE_H__
27
28 #ifdef __cplusplus
29 extern "C" {
30 #endif /* __cplusplus */
31
32 /** @file
33  * Convenience function for temporary file creation.
34  */
35
36
37 /**
38  * Create a tempfile with the given prefix (e.g. "wireshark"). The path
39  * is created using g_get_tmp_dir and mkstemp.
40  * 
41  * @param namebuf If not NULL, receives the full path of the temp file.
42  *                Must NOT be freed.
43  * @param pfx A prefix for the temporary file.
44  * @return The file descriptor of the new tempfile, from mkstemp().
45  */
46 int create_tempfile(char **namebuf, const char *pfx);
47
48 /**
49  * Create a directory with the given prefix (e.g. "wireshark"). The path
50  * is created using g_get_tmp_dir and mkdtemp.
51  * 
52  * @param namebuf If not NULL, receives the full path of the temp directory.
53  *                Must NOT be freed.
54  * @param pfx A prefix for the temporary directory.
55  * @return The temporary directory path on success, or NULL on failure.
56  *         Must NOT be freed.
57  */
58 const char *create_tempdir(char **namebuf, const char *pfx);
59
60 #ifdef __cplusplus
61 }
62 #endif /* __cplusplus */
63
64 #endif /* __TEMPFILE_H__ */