← Back to branch summary

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

« back to all changes in this revision

Viewing changes to lib/orber/doc/src/any.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/orber/doc/src/any.xml
 
1
<?xml version="1.0" encoding="latin1" ?>
 
2
<!DOCTYPE erlref SYSTEM "erlref.dtd">
 
3
 
 
4
<erlref>
 
5
  <header>
 
6
    <copyright>
 
7
      <year>1998</year>
 
8
      <year>2007</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>any</title>
 
27
    <prepared></prepared>
 
28
    <docno></docno>
 
29
    <checked></checked>
 
30
    <date>1998-04-20</date>
 
31
    <rev>A</rev>
 
32
  </header>
 
33
  <module>any</module>
 
34
  <modulesummary>the corba any type</modulesummary>
 
35
  <description>
 
36
    <p>This module contains functions that gives an interface to the CORBA any type.</p>
 
37
    <p>Note that the <c>any</c> interface in orber does not contain a destroy 
 
38
      function because the any type is represented as an Erlang record and 
 
39
      therefor will be removed by the garbage collector when not in use.</p>
 
40
    <p>The type <c>TC</c> used below describes an IDL type and is a tuple according 
 
41
      to the to the Erlang language mapping.</p>
 
42
    <p>The type <c>Any</c> used below is defined as:</p>
 
43
    <code type="none">
 
44
      -record(any, {typecode, value}).
 
45
    </code>
 
46
    <p>where <c>typecode</c> is a TC tuple and <c>value</c> is an Erlang term of 
 
47
      the type defined by the typecode field.</p>
 
48
  </description>
 
49
  <funcs>
 
50
    <func>
 
51
      <name>create() -> Result</name>
 
52
      <name>create(Typecode, Value) -> Result</name>
 
53
      <fsummary>Create an any record</fsummary>
 
54
      <type>
 
55
        <v>Typecode = TC</v>
 
56
        <v>Value = term()</v>
 
57
        <v>Result = Any</v>
 
58
      </type>
 
59
      <desc>
 
60
        <p>The create/0 function creates an empty any record and the create/2 
 
61
          function creates an initialized record.</p>
 
62
      </desc>
 
63
    </func>
 
64
    <func>
 
65
      <name>set_typecode(A, Typecode) -> Result</name>
 
66
      <fsummary>Set the typecode field</fsummary>
 
67
      <type>
 
68
        <v>A = Any</v>
 
69
        <v>Typecode = TC</v>
 
70
        <v>Result = Any</v>
 
71
      </type>
 
72
      <desc>
 
73
        <p>This function sets the typecode of <em>A</em> and returns a 
 
74
          new any record.</p>
 
75
      </desc>
 
76
    </func>
 
77
    <func>
 
78
      <name>get_typecode(A) -> Result</name>
 
79
      <fsummary>Fetch the typecode</fsummary>
 
80
      <type>
 
81
        <v>A = Any</v>
 
82
        <v>Result = TC</v>
 
83
      </type>
 
84
      <desc>
 
85
        <p>This function returns the typecode of <em>A</em>.</p>
 
86
      </desc>
 
87
    </func>
 
88
    <func>
 
89
      <name>set_value(A, Value) -> Result</name>
 
90
      <fsummary>Set the value field</fsummary>
 
91
      <type>
 
92
        <v>A = Any</v>
 
93
        <v>Value = term()</v>
 
94
        <v>Result = Any</v>
 
95
      </type>
 
96
      <desc>
 
97
        <p>This function sets the value of <em>A</em> and returns a 
 
98
          new any record.</p>
 
99
      </desc>
 
100
    </func>
 
101
    <func>
 
102
      <name>get_value(A) -> Result</name>
 
103
      <fsummary>Fetch the value</fsummary>
 
104
      <type>
 
105
        <v>A = Any</v>
 
106
        <v>Result = term()</v>
 
107
      </type>
 
108
      <desc>
 
109
        <p>This function returns the value of <em>A</em>.
 
110
          </p>
 
111
      </desc>
 
112
    </func>
 
113
  </funcs>
 
114
  
 
115
</erlref>
 
116