Avoid assert() when loading xml: Throw an XMLerror if attribute_value fails.
[ardour.git] / libs / pbd / pbd / windows_special_dirs.h
1 /*
2     Copyright (C) 2008 John Emmas
3
4     This program is free software; you can redistribute it and/or modify
5     it under the terms of the GNU General Public License as published by
6     the Free Software Foundation; either version 2 of the License, or
7     (at your option) any later version.
8
9     This program is distributed in the hope that it will be useful,
10     but WITHOUT ANY WARRANTY; without even the implied warranty of
11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12     GNU General Public License for more details.
13
14     You should have received a copy of the GNU General Public License
15     along with this program; if not, write to the Free Software
16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17
18 */
19
20 #ifndef __libpbd_windows_special_dirs_h__
21 #define __libpbd_windows_special_dirs_h__
22
23 #include <string>
24
25 #include "pbd/libpbd_visibility.h"
26
27 namespace PBD {
28
29 /**
30 * Gets the full path that corresponds of one of the Windows special folders,
31 * such as "My Documents" and the like.
32 *
33 * @param csidl corresponds to CSIDL values, such as CSIDL_SYSTEM etc.
34 * @return A string containing the name of the special folder or an empty
35 * string on failure.
36 */
37 LIBPBD_API std::string get_win_special_folder_path (int csidl);
38
39 }
40
41 #endif /* __libpbd_windows_special_dirs_h__ */