SAGA API Version 9.14
Loading...
Searching...
No Matches
api_config.h
Go to the documentation of this file.
1
3// //
4// SAGA //
5// //
6// System for Automated Geoscientific Analyses //
7// //
8// Application Programming Interface //
9// //
10// Library: SAGA_API //
11// //
12//-------------------------------------------------------//
13// //
14// api_config.h //
15// //
16// Copyright (C) 2026 by Olaf Conrad //
17// //
18//-------------------------------------------------------//
19// //
20// This file is part of 'SAGA - System for Automated //
21// Geoscientific Analyses'. //
22// //
23// This library is free software; you can redistribute //
24// it and/or modify it under the terms of the GNU Lesser //
25// General Public License as published by the Free //
26// Software Foundation, either version 2.1 of the //
27// License, or (at your option) any later version. //
28// //
29// This library is distributed in the hope that it will //
30// be useful, but WITHOUT ANY WARRANTY; without even the //
31// implied warranty of MERCHANTABILITY or FITNESS FOR A //
32// PARTICULAR PURPOSE. See the GNU Lesser General Public //
33// License for more details. //
34// //
35// You should have received a copy of the GNU Lesser //
36// General Public License along with this program; if //
37// not, see <http://www.gnu.org/licenses/>. //
38// //
39//-------------------------------------------------------//
40// //
41// contact: Olaf Conrad //
42// Institute of Geography //
43// University of Hamburg //
44// Germany //
45// //
46// e-mail: oconrad@saga-gis.org //
47// //
49
50//---------------------------------------------------------
51#ifndef HEADER_INCLUDED__SAGA_API__api_config_H
52#define HEADER_INCLUDED__SAGA_API__api_config_H
53
54
56// //
57// //
58// //
60
61//---------------------------------------------------------
62#include "parameters.h"
63
64
66// //
67// //
68// //
70
71//---------------------------------------------------------
72SAGA_API_DLL_EXPORT bool SG_Config_Do_Save (bool bOn);
73SAGA_API_DLL_EXPORT bool SG_Config_Flush (void);
74
75SAGA_API_DLL_EXPORT bool SG_Config_Read (const CSG_String &Group, const CSG_String &Entry, CSG_String &Value);
76SAGA_API_DLL_EXPORT bool SG_Config_Read (const CSG_String &Group, const CSG_String &Entry, long &Value);
77SAGA_API_DLL_EXPORT bool SG_Config_Read (const CSG_String &Group, const CSG_String &Entry, double &Value);
78SAGA_API_DLL_EXPORT bool SG_Config_Read (const CSG_String &Group, const CSG_String &Entry, bool &Value);
79
80SAGA_API_DLL_EXPORT bool SG_Config_Write (const CSG_String &Group, const CSG_String &Entry, const CSG_String &Value);
81SAGA_API_DLL_EXPORT bool SG_Config_Write (const CSG_String &Group, const CSG_String &Entry, const char *Value);
82SAGA_API_DLL_EXPORT bool SG_Config_Write (const CSG_String &Group, const CSG_String &Entry, const wchar_t *Value);
83SAGA_API_DLL_EXPORT bool SG_Config_Write (const CSG_String &Group, const CSG_String &Entry, long Value);
84SAGA_API_DLL_EXPORT bool SG_Config_Write (const CSG_String &Group, const CSG_String &Entry, double Value);
85SAGA_API_DLL_EXPORT bool SG_Config_Write (const CSG_String &Group, const CSG_String &Entry, bool Value);
86
87SAGA_API_DLL_EXPORT bool SG_Config_Delete (const CSG_String &Group);
88SAGA_API_DLL_EXPORT bool SG_Config_Delete (const CSG_String &Group, const CSG_String &Entry);
89
90SAGA_API_DLL_EXPORT bool SG_Config_Read (const CSG_String &Group, CSG_Parameters &Parameters);
91SAGA_API_DLL_EXPORT bool SG_Config_Write (const CSG_String &Group, const CSG_Parameters &Parameters);
92
93
95// //
96// //
97// //
99
100//---------------------------------------------------------
101#endif // #ifndef HEADER_INCLUDED__SAGA_API__api_config_H
SG_Config_Flush
SAGA_API_DLL_EXPORT bool SG_Config_Flush(void)
Definition api_config.cpp:88
SG_Config_Read
SAGA_API_DLL_EXPORT bool SG_Config_Read(const CSG_String &Group, const CSG_String &Entry, CSG_String &Value)
Definition api_config.cpp:94
SG_Config_Delete
SAGA_API_DLL_EXPORT bool SG_Config_Delete(const CSG_String &Group)
Definition api_config.cpp:204
SG_Config_Write
SAGA_API_DLL_EXPORT bool SG_Config_Write(const CSG_String &Group, const CSG_String &Entry, const CSG_String &Value)
Definition api_config.cpp:134
SG_Config_Do_Save
SAGA_API_DLL_EXPORT bool SG_Config_Do_Save(bool bOn)
Definition api_config.cpp:72
SAGA_API_DLL_EXPORT
#define SAGA_API_DLL_EXPORT
Definition api_core.h:94
CSG_Parameters
Definition parameters.h:1703
CSG_String
Definition api_core.h:563