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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
|
<?xml version="1.0" encoding="latin1" ?>
<!DOCTYPE erlref SYSTEM "erlref.dtd">
<erlref>
<header>
<copyright>
<year>2000</year><year>2009</year>
<holder>Ericsson AB. All Rights Reserved.</holder>
</copyright>
<legalnotice>
The contents of this file are subject to the Erlang Public License,
Version 1.1, (the "License"); you may not use this file except in
compliance with the License. You should have received a copy of the
Erlang Public License along with this software. If not, it can be
retrieved online at http://www.erlang.org/.
Software distributed under the License is distributed on an "AS IS"
basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
the License for the specific language governing rights and limitations
under the License.
</legalnotice>
<title>cosProperty</title>
<prepared></prepared>
<docno></docno>
<checked></checked>
<date>2000-06-07</date>
<rev>PA1</rev>
</header>
<module>cosProperty</module>
<modulesummary>The main module of the cosProperty application</modulesummary>
<description>
<p>To get access to the record definitions for the structures use: <br></br>
<c>-include_lib("cosProperty/include/*.hrl").</c></p>
<p>This module contains the functions for starting and stopping the application.</p>
</description>
<funcs>
<func>
<name>install() -> Return</name>
<fsummary>Install the cosProperty application in the IFR</fsummary>
<type>
<v>Return = ok | {'EXIT', Reason}</v>
</type>
<desc>
<p>This operation installs the cosProperty application in the IFR.</p>
</desc>
</func>
<func>
<name>install_db() -> Return</name>
<fsummary>Install data in mnesia necessary for running the cosProperty application</fsummary>
<type>
<v>Return = ok | {'EXIT', Reason}</v>
</type>
<desc>
<p>This operation installs data in mnesia necessary for running the
cosProperty application.</p>
</desc>
</func>
<func>
<name>uninstall() -> Return</name>
<fsummary>Remove all data in the IFR related to the cosProperty application</fsummary>
<type>
<v>Return = ok | {'EXIT', Reason}</v>
</type>
<desc>
<p>This operation removes all data in the IFR related to the cosProperty
application.</p>
</desc>
</func>
<func>
<name>uninstall_db() -> Return</name>
<fsummary>Remove all data from mnesia related to the cosProperty application</fsummary>
<type>
<v>Return = ok | {'EXIT', Reason}</v>
</type>
<desc>
<p>This operation removes all data from mnesia related to the cosProperty
application.</p>
</desc>
</func>
<func>
<name>start() -> Return</name>
<fsummary>Start the cosProperty application</fsummary>
<type>
<v>Return = ok | {error, Reason}</v>
</type>
<desc>
<p>This operation starts the cosProperty application.</p>
</desc>
</func>
<func>
<name>start_SetDefFactory() -> Return</name>
<fsummary>Start a PropertySetDef Factory</fsummary>
<type>
<v>Return = Factory | {'EXCEPTION', E}</v>
<v>Factory = CosPropertyService::PropertySetDefFactory reference.</v>
</type>
<desc>
<p>This operation starts a PropertySetDef Factory.</p>
</desc>
</func>
<func>
<name>start_SetFactory() -> Return</name>
<fsummary>Start a PropertySet Factory</fsummary>
<type>
<v>Return = Factory | {'EXCEPTION', E}</v>
<v>Factory = CosPropertyService::PropertySetDefFactory reference.</v>
</type>
<desc>
<p>This operation starts a PropertySet Factory.</p>
</desc>
</func>
<func>
<name>stop_SetDefFactory(Factory) -> Return</name>
<fsummary>Stop the given PropertySetDef Factory</fsummary>
<type>
<v>Factory = CosPropertyService::PropertySetDefFactory reference.</v>
<v>Return = ok | {'EXCEPTION', E}</v>
</type>
<desc>
<p>This operation stops the supplied PropertySetDef Factory.</p>
</desc>
</func>
<func>
<name>stop_SetFactory(Factory) -> Return</name>
<fsummary>Stop the given PropertySet Factory</fsummary>
<type>
<v>Factory = CosPropertyService::PropertySetFactory reference.</v>
<v>Return = ok | {'EXCEPTION', E}</v>
</type>
<desc>
<p>This operation stops the supplied PropertySet Factory.</p>
</desc>
</func>
<func>
<name>stop() -> Return</name>
<fsummary>Stop the cosProperty application</fsummary>
<type>
<v>Return = ok | {error, Reason}</v>
</type>
<desc>
<p>This operation stops the cosProperty application.</p>
</desc>
</func>
</funcs>
</erlref>
|
