File: user_get_option.xml

package info (click to toggle)
virtuoso-opensource 7.2.5.1%2Bdfsg1-0.3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 285,240 kB
  • sloc: ansic: 641,220; sql: 490,413; xml: 269,570; java: 83,893; javascript: 79,900; cpp: 36,927; sh: 31,653; cs: 25,702; php: 12,690; yacc: 10,227; lex: 7,601; makefile: 7,129; jsp: 4,523; awk: 1,697; perl: 1,013; ruby: 1,003; python: 326
file content (87 lines) | stat: -rw-r--r-- 3,561 bytes parent folder | download | duplicates (2)
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
<?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_USER_GET_OPTION">
  <refmeta>
    <refentrytitle>USER_GET_OPTION</refentrytitle>
    <refmiscinfo>admin</refmiscinfo>
  </refmeta>
  <refnamediv>
    <refname>USER_GET_OPTION</refname>
    <refpurpose>Retrieve a user option for a given user account.</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <funcsynopsis id="fsyn_USER_GET_OPTION">
      <funcprototype id="fproto_USER_GET_OPTION">
        <funcdef><function>USER_GET_OPTION</function></funcdef>
	<paramdef>in <parameter>name</parameter> varchar</paramdef>
	<paramdef>in <parameter>opt</parameter> varchar</paramdef>
      </funcprototype>
    </funcsynopsis>
  </refsynopsisdiv>
  <refsect1 id="desc_USER_GET_OPTION">
    <title>Description</title>
    <para>This function is used to retrieve an existing user option.</para>
  </refsect1>
  <refsect1 id="params_USER_GET_OPTION">
    <title>Parameters</title>
    <refsect2><title>name</title>
      <para>The name of the user account.</para>
    </refsect2>
    <refsect2><title>opt</title>
      <para>Option name.</para>
    </refsect2>
  </refsect1>
  <refsect1 id="ret_USER_GET_OPTION"><title>Return Types</title>
    <para>any, depending on option</para>
  </refsect1>
<!--
  <refsect1 id="errors_USER_GET_OPTION">
    <title>Errors</title>
    <para>This function can generate the following errors:</para>
    <errorcode></errorcode>
  </refsect1>
  <refsect1 id="examples_USER_GET_OPTION">
    <title>Examples</title>
    <example id="ex_USER_GET_OPTION"><title></title>
      <para></para>
      <screen><![CDATA[
]]>
</screen>
    </example>
  </refsect1>
-->
  <refsect1 id="seealso_USER_GET_OPTION">
    <title>See Also</title>
    <para><link linkend="vumuseroptions">User Options Section</link></para>
    <para><link linkend="fn_USER_CREATE"><function>USER_CREATE()</function></link></para>
    <para><link linkend="fn_USER_ROLE_CREATE"><function>USER_ROLE_CREATE()</function></link></para>
    <para><link linkend="fn_USER_DROP"><function>USER_DROP()</function></link></para>
    <para><link linkend="fn_USER_ROLE_DROP"><function>USER_ROLE_DROP()</function></link></para>
    <para><link linkend="fn_USER_CHANGE_PASSWORD"><function>USER_CHANGE_PASSWORD()</function></link></para>
    <para><link linkend="fn_USER_SET_QUALIFIER"><function>USER_SET_QUALIFIER()</function></link></para>
    <para><link linkend="fn_USER_GRANT_ROLE"><function>USER_GRANT_ROLE()</function></link></para>
    <para><link linkend="fn_USER_REVOKE_ROLE"><function>USER_REVOKE_ROLE()</function></link></para>
    <para><link linkend="fn_USER_SET_OPTION"><function>USER_SET_OPTIONS()</function></link></para>
  </refsect1>
</refentry>