# CosNaming_BindingIterator

### MODULE

CosNaming_BindingIterator

### MODULE SUMMARY

This interface supports iteration over a name binding list.

### DESCRIPTION

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").

### EXPORTS

`next_one(BindinIterator) -> Return`

Types:

`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`

Types:

`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`

Types:

`BindingIterator = #objref`
`Return = ok`

This operation destroys the binding iterator.

### AUTHORS

Lars Thorsén - support@erlang.ericsson.se

orber 3.6.3
Copyright © 1991-2006 Ericsson AB