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
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
|
<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
-
- This file is part of the OpenLink Software Virtuoso Open-Source (VOS)
- project.
-
- Copyright (C) 1998-2018 OpenLink Software
-
- This project 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; only version 2 of the License, dated June 1991.
-
- 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.,
- 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-
-
-->
<refentry id="fn_cfg_write">
<refmeta>
<refentrytitle>cfg_write</refentrytitle>
<refmiscinfo>admin</refmiscinfo>
</refmeta>
<refnamediv>
<refname>cfg_write</refname>
<refpurpose>Writes the item=value to an INI file</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_cfg_write">
<funcprototype id="fproto_cfg_write">
<funcdef><function>cfg_write</function></funcdef>
<paramdef>in <parameter>path </parameter>varchar</paramdef>
<paramdef>in <parameter>section </parameter>varchar</paramdef>
<paramdef>in <parameter>item_name </parameter>varchar</paramdef>
<paramdef>in <parameter>item_value </parameter>varchar</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc_cfg_write"><title>Description</title>
<para>This function requires dba privileges.</para>
<para>This function allows modification of existing entries, or update
updating existing items in an INI file.</para>
</refsect1>
<refsect1 id="params_cfg_write"><title>Parameters</title>
<refsect2><title>path</title>
<para>Name of the INI file.</para>
</refsect2>
<refsect2><title>section</title>
<para>Name of the section in the INI file.</para>
</refsect2>
<refsect2><title>item_name</title>
<para>Name of item that will be assigned the item_value.</para>
</refsect2>
<refsect2><title>item_value</title>
<para>Value to be assigned to the item_name.</para>
</refsect2>
</refsect1>
<refsect1 id="examples_cfg_write"><title>Examples</title>
<example id="ex_cfg_write"><title>Simple examples</title>
<para>Write ServerPort=2222 under the [Parameters] section of the
current virtuoso.ini file.</para>
<screen>
SQL> cfg_write(virtuoso_ini_path(), 'Parameters','ServerPort','2222');
-- Verification
SQL> select cfg_item_value(virtuoso_ini_path(), 'Parameters','ServerPort');
callret
VARCHAR
___________________________________________________________________________
2222</screen>
</example>
</refsect1>
<refsect1 id="seealso_cfg_write"><title>See Also</title>
<para>
<link linkend="fn_virtuoso_ini_path"><function>virtuoso_ini_path</function></link>
<link linkend="fn_cfg_section_count"><function>cfg_section_count</function></link>
<link linkend="fn_cfg_section_name"><function>cfg_section_name</function></link>
<link linkend="fn_cfg_item_count"><function>cfg_item_count</function></link>
<link linkend="fn_cfg_item_name"><function>cfg_item_name</function></link>
<link linkend="fn_cfg_item_value"><function>cfg_item_value</function></link>
</para>
</refsect1>
</refentry>
|
