Add pbd/types_convert.h header for PBD::to_string/string_to specialisations
[ardour.git] / libs / pbd / pbd / windows_special_dirs.h
index c557ef4c168cf76e668cdcb7202757fcbb9b3550..0bc5accc969d527f4de51de1c208ea7b13058524 100644 (file)
 #ifndef __libpbd_windows_special_dirs_h__
 #define __libpbd_windows_special_dirs_h__
 
+#include <string>
+
 #include "pbd/libpbd_visibility.h"
 
 namespace PBD {
-       LIBPBD_API char * get_win_special_folder (int csidl);
+
+/**
+* Gets the full path that corresponds of one of the Windows special folders,
+* such as "My Documents" and the like.
+*
+* @param csidl corresponds to CSIDL values, such as CSIDL_SYSTEM etc.
+* @return A string containing the name of the special folder or an empty
+* string on failure.
+*/
+LIBPBD_API std::string get_win_special_folder_path (int csidl);
+
 }
 
 #endif /* __libpbd_windows_special_dirs_h__ */