File: fsutil.h

package info (click to toggle)
kde-config-systemd 1.2.1-3
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, buster, sid, stretch
  • size: 1,560 kB
  • ctags: 688
  • sloc: cpp: 3,306; makefile: 9; sh: 2
file content (43 lines) | stat: -rw-r--r-- 2,105 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
/*******************************************************************************
 * Copyright (C) 2015 Johan Ouwerkerk <jm.ouwerkerk@gmail.com>                 *
 *                                                                             *
 * This program is free software: you can redistribute it and/or modify it     *
 * under the terms of the GNU General Public License as published by the Free  *
 * Software Foundation, either version 2 of the License, or (at your option)   *
 * any later version.                                                          *
 *                                                                             *
 * This program is distributed in the hope that it will be useful, but WITHOUT *
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or       *
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for    *
 * more details.                                                               *
 *                                                                             *
 * You should have received a copy of the GNU General Public License along     *
 * with this program. If not, see <http://www.gnu.org/licenses/>.              *
 *******************************************************************************/

#ifndef KCMSYSTEMD_FSUTIL_H
#define KCMSYSTEMD_FSUTIL_H

#include <QString>

/**
 *
 * \brief determines the size (capacity) of an arbitrary partition in bytes.
 * Use like this:
 * \code
 * bool ok = false;
 * qulonglong size = getPartitionSize("some path", &ok);
 * if (ok)
 *    doSomething(size);
 * \code
 *
 * \param path An arbitrary path. The available space will be
 * determined for the partition containing path.
 * \param ok Error indicator (optional). If passed error status is reported by means
 * of a boolean flag which will be set to \p true if the function determined the partition
 * size successfully \p false otherwise.
 * \return the size of the partition containing the given path or 0 in case of errors.
 */
qulonglong getPartitionSize(const QString &path, bool *ok = NULL);

#endif