← Back to branch summary

~ubuntu-branches/debian/squeeze/erlang/squeeze

« back to all changes in this revision

Viewing changes to lib/cosProperty/doc/src/cosProperty.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sergei Golovan
  • Date: 2009-02-15 16:42:52 UTC
  • mfrom: (1.1.13 upstream)
  • Revision ID: james.westby@ubuntu.com-20090215164252-dxpjjuq108nz4noa
Tags: 1:12.b.5-dfsg-2
Upload to unstable after lenny is released.

Show diffs side-by-side

added added

removed removed

Lines of Context:
lib/cosProperty/doc/src/cosProperty.xml
 
1
<?xml version="1.0" encoding="latin1" ?>
 
2
<!DOCTYPE erlref SYSTEM "erlref.dtd">
 
3
 
 
4
<erlref>
 
5
  <header>
 
6
    <copyright>
 
7
      <year>2000</year>
 
8
      <year>2008</year>
 
9
      <holder>Ericsson AB, All Rights Reserved</holder>
 
10
    </copyright>
 
11
    <legalnotice>
 
12
  The contents of this file are subject to the Erlang Public License,
 
13
  Version 1.1, (the "License"); you may not use this file except in
 
14
  compliance with the License. You should have received a copy of the
 
15
  Erlang Public License along with this software. If not, it can be
 
16
  retrieved online at http://www.erlang.org/.
 
17
 
 
18
  Software distributed under the License is distributed on an "AS IS"
 
19
  basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
 
20
  the License for the specific language governing rights and limitations
 
21
  under the License.
 
22
 
 
23
  The Initial Developer of the Original Code is Ericsson AB.
 
24
    </legalnotice>
 
25
 
 
26
    <title>cosProperty</title>
 
27
    <prepared></prepared>
 
28
    <docno></docno>
 
29
    <checked></checked>
 
30
    <date>2000-06-07</date>
 
31
    <rev>PA1</rev>
 
32
  </header>
 
33
  <module>cosProperty</module>
 
34
  <modulesummary>The main module of the cosProperty application</modulesummary>
 
35
  <description>
 
36
    <p>To get access to the record definitions for the structures use:      <br></br>
 
37
<c>-include_lib("cosProperty/include/*.hrl").</c></p>
 
38
    <p>This module contains the functions for starting and stopping the application.</p>
 
39
  </description>
 
40
  <funcs>
 
41
    <func>
 
42
      <name>install() -> Return</name>
 
43
      <fsummary>Install the cosProperty application in the IFR</fsummary>
 
44
      <type>
 
45
        <v>Return = ok | {'EXIT', Reason}</v>
 
46
      </type>
 
47
      <desc>
 
48
        <p>This operation installs the cosProperty application in the IFR.</p>
 
49
      </desc>
 
50
    </func>
 
51
    <func>
 
52
      <name>install_db() -> Return</name>
 
53
      <fsummary>Install data in mnesia necessary for running the  cosProperty application</fsummary>
 
54
      <type>
 
55
        <v>Return = ok | {'EXIT', Reason}</v>
 
56
      </type>
 
57
      <desc>
 
58
        <p>This operation installs data in mnesia necessary for running the 
 
59
          cosProperty application.</p>
 
60
      </desc>
 
61
    </func>
 
62
    <func>
 
63
      <name>uninstall() -> Return</name>
 
64
      <fsummary>Remove all data in the IFR related to the cosProperty  application</fsummary>
 
65
      <type>
 
66
        <v>Return = ok | {'EXIT', Reason}</v>
 
67
      </type>
 
68
      <desc>
 
69
        <p>This operation removes all data in the IFR related to the cosProperty 
 
70
          application.</p>
 
71
      </desc>
 
72
    </func>
 
73
    <func>
 
74
      <name>uninstall_db() -> Return</name>
 
75
      <fsummary>Remove all data from mnesia related to the cosProperty application</fsummary>
 
76
      <type>
 
77
        <v>Return = ok | {'EXIT', Reason}</v>
 
78
      </type>
 
79
      <desc>
 
80
        <p>This operation removes all data from mnesia related to the cosProperty
 
81
          application.</p>
 
82
      </desc>
 
83
    </func>
 
84
    <func>
 
85
      <name>start() -> Return</name>
 
86
      <fsummary>Start the cosProperty application</fsummary>
 
87
      <type>
 
88
        <v>Return = ok | {error, Reason}</v>
 
89
      </type>
 
90
      <desc>
 
91
        <p>This operation starts the cosProperty application.</p>
 
92
      </desc>
 
93
    </func>
 
94
    <func>
 
95
      <name>start_SetDefFactory() -> Return</name>
 
96
      <fsummary>Start a PropertySetDef Factory</fsummary>
 
97
      <type>
 
98
        <v>Return = Factory | {'EXCEPTION', E}</v>
 
99
        <v>Factory = CosPropertyService::PropertySetDefFactory reference.</v>
 
100
      </type>
 
101
      <desc>
 
102
        <p>This operation starts a PropertySetDef Factory.</p>
 
103
      </desc>
 
104
    </func>
 
105
    <func>
 
106
      <name>start_SetFactory() -> Return</name>
 
107
      <fsummary>Start a PropertySet Factory</fsummary>
 
108
      <type>
 
109
        <v>Return = Factory | {'EXCEPTION', E}</v>
 
110
        <v>Factory = CosPropertyService::PropertySetDefFactory reference.</v>
 
111
      </type>
 
112
      <desc>
 
113
        <p>This operation starts a PropertySet Factory.</p>
 
114
      </desc>
 
115
    </func>
 
116
    <func>
 
117
      <name>stop_SetDefFactory(Factory) -> Return</name>
 
118
      <fsummary>Stop the given PropertySetDef Factory</fsummary>
 
119
      <type>
 
120
        <v>Factory = CosPropertyService::PropertySetDefFactory reference.</v>
 
121
        <v>Return = ok | {'EXCEPTION', E}</v>
 
122
      </type>
 
123
      <desc>
 
124
        <p>This operation stops the supplied PropertySetDef Factory.</p>
 
125
      </desc>
 
126
    </func>
 
127
    <func>
 
128
      <name>stop_SetFactory(Factory) -> Return</name>
 
129
      <fsummary>Stop the given PropertySet Factory</fsummary>
 
130
      <type>
 
131
        <v>Factory = CosPropertyService::PropertySetFactory reference.</v>
 
132
        <v>Return = ok | {'EXCEPTION', E}</v>
 
133
      </type>
 
134
      <desc>
 
135
        <p>This operation stops the supplied PropertySet Factory.</p>
 
136
      </desc>
 
137
    </func>
 
138
    <func>
 
139
      <name>stop() -> Return</name>
 
140
      <fsummary>Stop the cosProperty application</fsummary>
 
141
      <type>
 
142
        <v>Return = ok | {error, Reason}</v>
 
143
      </type>
 
144
      <desc>
 
145
        <p>This operation stops the cosProperty application.</p>
 
146
      </desc>
 
147
    </func>
 
148
  </funcs>
 
149
  
 
150
</erlref>
 
151