From 84adefa331c4159d432d22840663c38f155cd4c1 Mon Sep 17 00:00:00 2001 From: Erlang/OTP Date: Fri, 20 Nov 2009 14:54:40 +0000 Subject: The R13B03 release. --- lib/orber/doc/src/CosNaming_BindingIterator.xml | 98 +++++++++++++++++++++++++ 1 file changed, 98 insertions(+) create mode 100644 lib/orber/doc/src/CosNaming_BindingIterator.xml (limited to 'lib/orber/doc/src/CosNaming_BindingIterator.xml') diff --git a/lib/orber/doc/src/CosNaming_BindingIterator.xml b/lib/orber/doc/src/CosNaming_BindingIterator.xml new file mode 100644 index 0000000000..83972a6009 --- /dev/null +++ b/lib/orber/doc/src/CosNaming_BindingIterator.xml @@ -0,0 +1,98 @@ + + + + +
+ + 1997 + 2007 + Ericsson AB, All Rights Reserved + + + 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. + + The Initial Developer of the Original Code is Ericsson AB. + + + CosNaming_BindingIterator + + + + 1997-06-10 + A +
+ CosNaming_BindingIterator + This interface supports iteration over a name binding list. + +

This interface allows a client to iterate over the Bindinglist it has been + initiated with.

+

The type NameComponent used below is defined as:

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

id and kind are strings.

+

The type Binding used below is defined as:

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

binding_name is a Name = [NameComponent] and + binding_type is an enum which + has the values nobject and ncontext.

+

Both these records are defined in the file CosNaming.hrl and it + is included with:

+ + -include_lib("orber/COSS/CosNaming/CosNaming.hrl"). + + + + + next_one(BindinIterator) -> Return + Return a binding + + BindingIterator = #objref + Return = {bool(), Binding} + + +

This operation returns the next binding and a boolean. The latter + is set to true if the binding is valid otherwise false. If the boolean + is false there are no more bindings to retrieve.

+ + + + next_n(BindinIterator, HowMany) -> Return + Return a binding list + + BindingIterator = #objref + HowMany = int() + BindingList = [Binding] + Return = {bool(), BindingList} + + +

This operation returns a binding list with at most HowMany bindings. + If there are no more bindings it returns false otherwise true.

+ + + + destroy(BindingIterator) -> Return + Destroy the iterator object + + BindingIterator = #objref + Return = ok + + +

This operation destroys the binding iterator.

+ + + + + + -- cgit v1.2.3