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
|
.TH CosFileTransfer_FileIterator 3 "cosFileTransfer 1.1.5" "Ericsson AB" "ERLANG MODULE DEFINITION"
.SH MODULE
CosFileTransfer_FileIterator \- This module implements the OMG CosFileTransfer::FileIterator interface\&.
.SH DESCRIPTION
.LP
To get access to the record definitions for the structures use:
.br
\fI-include_lib("cosFileTransfer/include/*\&.hrl")\&.\fR
.SH EXPORTS
.LP
.B
next_one(Iterator) -> Return
.br
.RS
.TP
Types
Iterator = #objref
.br
Return = {boolean(), #\&'CosFileTransfer_FileWrapper\&'{the_file = File file_type = Type}}
.br
File = #objref
.br
Type = nfile | ndirectory
.br
.RE
.RS
.LP
This operation returns true if a \fIFileWrapper\fR exists at the current position and the out parameter contains a valid \fIFile\fR reference\&. If false is returned the out parameter is a non-valid \fIFileWrapper\fR\&.
.RE
.LP
.B
next_n(Iterator, Max) -> Return
.br
.RS
.TP
Types
Iterator = #objref
.br
Max = unsigned long()
.br
Return = {boolean(), FileList}
.br
FileList = [#\&'CosFileTransfer_FileWrapper\&'{the_file = File file_type = Type}]
.br
File = #objref
.br
Type = nfile | ndirectory
.br
.RE
.RS
.LP
This operation returns true if the requested number of \fIFileWrappers\fR can be delivered and there are additional \fIFileWrappers\fR\&. If false is returned a list, of length \fIMax\fR or less, containing the last valid \fIFileWrappers\fR associated with the target object\&.
.RE
.LP
.B
destroy(Iterator) -> ok
.br
.RS
.TP
Types
Iterator = #objref
.br
.RE
.RS
.LP
This operation terminates the target object\&.
.RE
|