File: CosPropertyService_PropertiesIterator.3

package info (click to toggle)
erlang-manpages 1%3A12.b.3-1
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 4,188 kB
  • ctags: 2
  • sloc: makefile: 68; perl: 30; sh: 15
file content (82 lines) | stat: -rw-r--r-- 1,607 bytes parent folder | download
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
.TH CosPropertyService_PropertiesIterator 3 "cosProperty  1.1.6" "Ericsson AB" "ERLANG MODULE DEFINITION"
.SH MODULE
CosPropertyService_PropertiesIterator \- This module implements the OMG CosPropertyService::PropertiesIterator interface\&.
.SH DESCRIPTION
.LP
To get access to the record definitions for the structures use: 
.br
\fI-include_lib("cosProperty/include/CosPropertyService\&.hrl")\&.\fR

.SH EXPORTS
.LP
.B
reset(Iterator) -> ok
.br
.RS
.TP
Types
Iterator = #objref
.br
.RE
.RS
.LP
This operation resets the position to the first property\&. 
.RE
.LP
.B
next_one(Iterator) -> Reply
.br
.RS
.TP
Types
Iterator = #objref
.br
Reply = {boolean(), #\&'CosPropertyService_Property\&'{property_name = Name, property_value = Value}}
.br
Name = string()
.br
Value = #any
.br
.RE
.RS
.LP
This operation returns true \&. If false is returned the out parameter is a non-valid Property\&.
.RE
.LP
.B
next_n(Iterator, HowMany) -> Reply
.br
.RS
.TP
Types
Iterator = #objref
.br
HowMany = long()
.br
Reply = {boolean(), Properties}
.br
Properties = [#\&'CosPropertyService_Property\&'{property_name = Name, property_value = Value}]
.br
Name = string()
.br
Value = #any
.br
.RE
.RS
.LP
This operation returns true if the requested number of properties can be delivered and there are additional properties\&. If false is returned and a sequence of max \fIHowMany\fR properties will be returned and no more properties can be delivered\&. 
.RE
.LP
.B
destroy(Iterator) -> ok
.br
.RS
.TP
Types
Iterator = #objref
.br
.RE
.RS
.LP
This operation will terminate the Iterator and all subsequent calls will fail\&. 
.RE