← Back to branch summary

~ubuntu-branches/ubuntu/karmic/mergeant/karmic

« back to all changes in this revision

Viewing changes to doc/libmergeant/C/tmpl/mg-server-function.sgml

  • Committer: Bazaar Package Importer
  • Author(s): Gustavo R. Montesino
  • Date: 2007-11-29 08:44:48 UTC
  • mfrom: (2.1.4 hardy)
  • Revision ID: james.westby@ubuntu.com-20071129084448-6aon73d22bv6hzfw
Tags: 0.67-3
* Re-enable installation of the mime files in mergeant.install
* mergeant.dirs: create usr/share/mime/packages to make dh_installmime add
  the update-mime-database code snippets

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/libmergeant/C/tmpl/mg-server-function.sgml
1
 
<!-- ##### SECTION Title ##### -->
2
 
MgServerFunction
3
 
 
4
 
<!-- ##### SECTION Short_Description ##### -->
5
 
Represents a function in the DBMS.
6
 
 
7
 
<!-- ##### SECTION Long_Description ##### -->
8
 
<para>
9
 
The #MgServerFunction represents a function, it has zero or more input parameters, and one and
10
 
only one return type. In this way it does not represent procedures which does not return any data type.
11
 
Also the argument types are always of the IN kind (no OUT or IN OUT kinds); there may one day be a specific
12
 
object for procedures. It does not either represent a function returning a SET OF a given data type; there may 
13
 
on day be a specific object for such functions.
14
 
</para>
15
 
<para>
16
 
Because functions can be polymorphic, the name is not enough to identify them, so the
17
 
DBMS provides a unique id which can be used to uniquely identify a function.
18
 
</para>
19
 
<para>
20
 
It implements the #MgXmlStorage interface.
21
 
</para>
22
 
 
23
 
<!-- ##### SECTION See_Also ##### -->
24
 
<para>
25
 
 
26
 
</para>
27
 
 
28
 
<!-- ##### STRUCT MgServerFunction ##### -->
29
 
<para>
30
 
 
31
 
</para>
32
 
 
33
 
 
34
 
<!-- ##### SIGNAL MgServerFunction::templ-signal ##### -->
35
 
<para>
36
 
 
37
 
</para>
38
 
 
39
 
@mgserverfunction: the object which received the signal.
40
 
 
41
 
<!-- ##### ARG MgServerFunction:prop ##### -->
42
 
<para>
43
 
 
44
 
</para>
45
 
 
46
 
<!-- ##### STRUCT MgServerFunctionPrivate ##### -->
47
 
<para>
48
 
 
49
 
</para>
50
 
 
51
 
 
52
 
<!-- ##### FUNCTION mg_server_function_get_type ##### -->
53
 
<para>
54
 
 
55
 
</para>
56
 
 
57
 
@Returns: 
58
 
 
59
 
 
60
 
<!-- ##### FUNCTION mg_server_function_new ##### -->
61
 
<para>
62
 
 
63
 
</para>
64
 
 
65
 
@srv: 
66
 
@Returns: 
67
 
 
68
 
 
69
 
<!-- ##### FUNCTION mg_server_function_set_dbms_id ##### -->
70
 
<para>
71
 
 
72
 
</para>
73
 
 
74
 
@func: 
75
 
@id: 
76
 
 
77
 
 
78
 
<!-- ##### FUNCTION mg_server_function_get_dbms_id ##### -->
79
 
<para>
80
 
 
81
 
</para>
82
 
 
83
 
@func: 
84
 
@Returns: 
85
 
 
86
 
 
87
 
<!-- ##### FUNCTION mg_server_function_set_sqlname ##### -->
88
 
<para>
89
 
 
90
 
</para>
91
 
 
92
 
@func: 
93
 
@sqlname: 
94
 
 
95
 
 
96
 
<!-- ##### FUNCTION mg_server_function_get_sqlname ##### -->
97
 
<para>
98
 
 
99
 
</para>
100
 
 
101
 
@func: 
102
 
@Returns: 
103
 
 
104
 
 
105
 
<!-- ##### FUNCTION mg_server_function_set_arg_types ##### -->
106
 
<para>
107
 
 
108
 
</para>
109
 
 
110
 
@func: 
111
 
@arg_types: 
112
 
 
113
 
 
114
 
<!-- ##### FUNCTION mg_server_function_get_arg_types ##### -->
115
 
<para>
116
 
 
117
 
</para>
118
 
 
119
 
@func: 
120
 
@Returns: 
121
 
 
122
 
 
123
 
<!-- ##### FUNCTION mg_server_function_set_ret_type ##### -->
124
 
<para>
125
 
 
126
 
</para>
127
 
 
128
 
@func: 
129
 
@dt: 
130
 
 
131
 
 
132
 
<!-- ##### FUNCTION mg_server_function_get_ret_type ##### -->
133
 
<para>
134
 
 
135
 
</para>
136
 
 
137
 
@func: 
138
 
@Returns: 
139
 
 
140
 
 
141
 
<!-- ##### FUNCTION mg_server_function_accepts_args ##### -->
142
 
<para>
143
 
 
144
 
</para>
145
 
 
146
 
@func: 
147
 
@arg_types: 
148
 
@Returns: 
149
 
 
150