Tim Mayberry
a2fbce0e7f
Rename it get_win_special_folder_path to indicate what it is returning Move documentation for the function into the header and use doxygen style comments. Fixes a couple of memory leaks in ArdourVideoToolPaths class although it looks as if there are more.
42 lines
1.3 KiB
C++
42 lines
1.3 KiB
C++
/*
|
|
Copyright (C) 2008 John Emmas
|
|
|
|
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, write to the Free Software
|
|
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
|
|
|
|
*/
|
|
|
|
#ifndef __libpbd_windows_special_dirs_h__
|
|
#define __libpbd_windows_special_dirs_h__
|
|
|
|
#include <string>
|
|
|
|
#include "pbd/libpbd_visibility.h"
|
|
|
|
namespace PBD {
|
|
|
|
/**
|
|
* 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__ */
|