wsutil/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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  23  */
  24
  25 #ifndef __TEMPFILE_H__
  26 #define __TEMPFILE_H__
  27
  28 #include "ws_symbol_export.h"
  29
  30 #ifdef __cplusplus
  31 extern "C" {
  32 #endif /* __cplusplus */
  33
  34 /** @file
  35  * Convenience function for temporary file creation.
  36  */
  37
  38 /**
  39  * Construct the path name of a file in the appropriate temporary
  40  * file directory.
  41  *
  42  * @param filename the file name to be given to the file.
  43  * @return the pathname of the file, g_malloced so the caller
  44  * should g_free it.
  45  */
  46 WS_DLL_PUBLIC char *get_tempfile_path(const char *filename);
  47
  48 /**
  49  * Create a tempfile with the given prefix (e.g. "wireshark"). The path
  50  * is created using g_get_tmp_dir and mkstemp.
  51  *
  52  * @param namebuf [in,out] If not NULL, receives the full path of the temp file.
  53  *                Must NOT be freed.
  54  * @param pfx [in] A prefix for the temporary file.
  55  * @return The file descriptor of the new tempfile, from mkstemp().
  56  */
  57 WS_DLL_PUBLIC int create_tempfile(char **namebuf, const char *pfx);
  58
  59 /**
  60  * Create a directory with the given prefix (e.g. "wireshark"). The path
  61  * is created using g_get_tmp_dir and mkdtemp.
  62  *
  63  * @param namebuf If not NULL, receives the full path of the temp directory.
  64  *                Must NOT be freed.
  65  * @param pfx A prefix for the temporary directory.
  66  * @return The temporary directory path on success, or NULL on failure.
  67  *         Must NOT be freed.
  68  */
  69 WS_DLL_PUBLIC const char *create_tempdir(char **namebuf, const char *pfx);
  70
  71 #ifdef __cplusplus
  72 }
  73 #endif /* __cplusplus */
  74
  75 #endif /* __TEMPFILE_H__ */