1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85
|
.TH CosNaming_BindingIterator 3 "orber 3.6.9" "Ericsson AB" "ERLANG MODULE DEFINITION"
.SH MODULE
CosNaming_BindingIterator \- This interface supports iteration over a name binding list\&.
.SH DESCRIPTION
.LP
This interface allows a client to iterate over the Bindinglist it has been initiated with\&.
.LP
The type \fINameComponent\fR used below is defined as:
.nf
-record(\&'CosNaming_NameComponent\&', {id, kind=""})\&.
.fi
.LP
\fIid\fR and \fIkind\fR are strings\&.
.LP
The type \fIBinding\fR used below is defined as:
.nf
-record(\&'CosNaming_Binding\&', {binding_name, binding_type})\&.
.fi
.LP
\fIbinding_name\fR is a \fIName = [NameComponent]\fR and \fIbinding_type\fR is an enum which has the values \fInobject\fR and \fIncontext\fR\&.
.LP
Both these records are defined in the file \fICosNaming\&.hrl\fR and it is included with:
.nf
-include_lib("orber/COSS/CosNaming/CosNaming\&.hrl")\&.
.fi
.SH EXPORTS
.LP
.B
next_one(BindinIterator) -> Return
.br
.RS
.TP
Types
BindingIterator = #objref
.br
Return = {bool(), Binding}
.br
.RE
.RS
.LP
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\&.
.RE
.LP
.B
next_n(BindinIterator, HowMany) -> Return
.br
.RS
.TP
Types
BindingIterator = #objref
.br
HowMany = int()
.br
BindingList = [Binding]
.br
Return = {bool(), BindingList}
.br
.RE
.RS
.LP
This operation returns a binding list with at most HowMany bindings\&. If there are no more bindings it returns false otherwise true\&.
.RE
.LP
.B
destroy(BindingIterator) -> Return
.br
.RS
.TP
Types
BindingIterator = #objref
.br
Return = ok
.br
.RE
.RS
.LP
This operation destroys the binding iterator\&.
.RE
|