~rdoering/ubuntu/karmic/erlang/fix-535090

« back to all changes in this revision

Viewing changes to lib/orber/doc/src/CosNaming_BindingIterator.xml

• browse files at revision 3.1.2
• compare with another revision
• download diff
• download tarball
• view history from revision 3.1.2

Show diffs side-by-side

added

removed

lib/orber/doc/src/CosNaming_BindingIterator.xml

 

1

<?xml version="1.0" encoding="latin1" ?>

 

2

<!DOCTYPE erlref SYSTEM "erlref.dtd">

 

3

 

 

4

<erlref>

 

5

  <header>

 

6

    <copyright>

 

7

      <year>1997</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>CosNaming_BindingIterator</title>

 

27

    <prepared></prepared>

 

28

    <docno></docno>

 

29

    <checked></checked>

 

30

    <date>1997-06-10</date>

 

31

    <rev>A</rev>

 

32

  </header>

 

33

  <module>CosNaming_BindingIterator</module>

 

34

  <modulesummary>This interface supports iteration over a name binding list.</modulesummary>

 

35

  <description>

 

36

    <p>This interface allows a client to iterate over the Bindinglist it has been

 

37

      initiated with.</p>

 

38

    <p>The type <c>NameComponent</c> used below is defined as:</p>

 

39

    <code type="none">

 

40

      -record('CosNaming_NameComponent', {id, kind=""}).

 

41

    </code>

 

42

    <p><c>id</c> and <c>kind</c> are strings. </p>

 

43

    <p>The type <c>Binding</c> used below is defined as:</p>

 

44

    <code type="none">

 

45

      -record('CosNaming_Binding', {binding_name, binding_type}).

 

46

    </code>

 

47

    <p><c>binding_name</c> is a <c>Name = [NameComponent]</c> and

 

48

      <c>binding_type</c> is an enum which 

 

49

      has the values <c>nobject</c> and <c>ncontext</c>.</p>

 

50

    <p>Both these records are defined in the file <c>CosNaming.hrl</c> and it 

 

51

      is included with:</p>

 

52

    <code type="none">

 

53

      -include_lib("orber/COSS/CosNaming/CosNaming.hrl").

 

54

    </code>

 

55

  </description>

 

56

  <funcs>

 

57

    <func>

 

58

      <name>next_one(BindinIterator) -> Return</name>

 

59

      <fsummary>Return a binding</fsummary>

 

60

      <type>

 

61

        <v>BindingIterator = #objref</v>

 

62

        <v>Return = {bool(), Binding}</v>

 

63

      </type>

 

64

      <desc>

 

65

        <p>This operation returns the next binding and a boolean. The latter

 

66

          is set to true if the binding is valid otherwise false. If the boolean

 

67

          is false there are no more bindings to retrieve.</p>

 

68

      </desc>

 

69

    </func>

 

70

    <func>

 

71

      <name>next_n(BindinIterator, HowMany) -> Return</name>

 

72

      <fsummary>Return a binding list</fsummary>

 

73

      <type>

 

74

        <v>BindingIterator = #objref</v>

 

75

        <v>HowMany = int()</v>

 

76

        <v>BindingList = [Binding]</v>

 

77

        <v>Return = {bool(), BindingList}</v>

 

78

      </type>

 

79

      <desc>

 

80

        <p>This operation returns a binding list with at most HowMany bindings.

 

81

          If there are no more bindings it returns false otherwise true.</p>

 

82

      </desc>

 

83

    </func>

 

84

    <func>

 

85

      <name>destroy(BindingIterator) -> Return</name>

 

86

      <fsummary>Destroy the iterator object</fsummary>

 

87

      <type>

 

88

        <v>BindingIterator = #objref</v>

 

89

        <v>Return = ok</v>

 

90

      </type>

 

91

      <desc>

 

92

        <p>This operation destroys the binding iterator.</p>

 

93

      </desc>

 

94

    </func>

 

95

  </funcs>

 

96

  

 

97

</erlref>

 

98

 

• Older »

Loggerhead is a web-based interface for Breezy
Version: 2.0.1