D-Bus: dbus-file.h Source File

D-Bus 1.14.6

dbus-file.h
1/* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
2/* dbus-file.h dbus file related stuff (internal to D-Bus implementation)
3 *
4 * Copyright (C) 2002, 2003 Red Hat, Inc.
5 * Copyright (C) 2003 CodeFactory AB
6 *
7 * Licensed under the Academic Free License version 2.1
8 *
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22 *
23 */
24
25#ifndef DBUS_FILE_H
26#define DBUS_FILE_H
27
28//#include <dbus/dbus-types.h>
29#include <dbus/dbus-string.h>
30#include <dbus/dbus-errors.h>
31
32 DBUS_BEGIN_DECLS
33
42 dbus_bool_t _dbus_file_exists (const char *file);
43DBUS_PRIVATE_EXPORT
44 dbus_bool_t _dbus_file_get_contents (DBusString *str,
45 const DBusString *filename,
46 DBusError *error);
47 dbus_bool_t _dbus_string_save_to_file (const DBusString *str,
48 const DBusString *filename,
49 dbus_bool_t world_readable,
50 DBusError *error);
51
52 dbus_bool_t _dbus_make_file_world_readable (const DBusString *filename,
53 DBusError *error);
54
55 dbus_bool_t _dbus_create_file_exclusively (const DBusString *filename,
56 DBusError *error);
57DBUS_PRIVATE_EXPORT
58 dbus_bool_t _dbus_delete_file (const DBusString *filename,
59 DBusError *error);
60
63 DBUS_END_DECLS
64
65#endif
_dbus_file_exists
dbus_bool_t _dbus_file_exists(const char *file)
File interface.
Definition: dbus-sysdeps-util-unix.c:563
_dbus_delete_file
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_delete_file(const DBusString *filename, DBusError *error)
Deletes the given file.
Definition: dbus-file-unix.c:397
_dbus_create_file_exclusively
dbus_bool_t _dbus_create_file_exclusively(const DBusString *filename, DBusError *error)
Creates the given file, failing if the file already exists.
Definition: dbus-file-unix.c:351
_dbus_string_save_to_file
dbus_bool_t _dbus_string_save_to_file(const DBusString *str, const DBusString *filename, dbus_bool_t world_readable, DBusError *error)
Writes a string out to a file.
Definition: dbus-file-unix.c:164
_dbus_make_file_world_readable
dbus_bool_t _dbus_make_file_world_readable(const DBusString *filename, DBusError *error)
Makes the file readable by every user in the system.
Definition: dbus-file-unix.c:324
_dbus_file_get_contents
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_file_get_contents(DBusString *str, const DBusString *filename, DBusError *error)
Appends the contents of the given file to the string, returning error code.
Definition: dbus-file-unix.c:55
DBUS_BEGIN_DECLS
#define DBUS_BEGIN_DECLS
Macro used prior to declaring functions in the D-Bus header files.
DBUS_END_DECLS
#define DBUS_END_DECLS
Macro used after declaring functions in the D-Bus header files.
dbus_bool_t
dbus_uint32_t dbus_bool_t
A boolean, valid values are TRUE and FALSE.
Definition: dbus-types.h:35
DBusError
Object representing an exception.
Definition: dbus-errors.h:49
DBusString
Definition: dbus-string.h:43