1CosFileTransfer_FileIteratorE(r3l)ang Module DefinitCioosnFileTransfer_FileIterator(3)
2
3
4

NAME

6       CosFileTransfer_FileIterator  - This module implements the OMG CosFile‐
7       Transfer::FileIterator interface.
8

DESCRIPTION

10       To get access to the record definitions for the structures use:
11       -include_lib("cosFileTransfer/include/*.hrl").
12

EXPORTS

14       next_one(Iterator) -> Return
15
16              Types:
17
18                 Iterator = #objref
19                 Return = {boolean(),  #'CosFileTransfer_FileWrapper'{the_file
20                 = File file_type = Type}}
21                 File = #objref
22                 Type = nfile | ndirectory
23
24              This  operation returns true if a FileWrapper exists at the cur‐
25              rent position and the out parameter contains a valid File refer‐
26              ence.  If  false  is  returned  the out parameter is a non-valid
27              FileWrapper.
28
29       next_n(Iterator, Max) -> Return
30
31              Types:
32
33                 Iterator = #objref
34                 Max = unsigned long()
35                 Return = {boolean(), FileList}
36                 FileList =  [#'CosFileTransfer_FileWrapper'{the_file  =  File
37                 file_type = Type}]
38                 File = #objref
39                 Type = nfile | ndirectory
40
41              This operation returns true if the requested number of FileWrap‐
42              pers can be delivered and there are additional FileWrappers.  If
43              false  is returned a list, of length Max or less, containing the
44              last valid FileWrappers associated with the target object.
45
46       destroy(Iterator) -> ok
47
48              Types:
49
50                 Iterator = #objref
51
52              This operation terminates the target object.
53
54
55
56Ericsson AB                   cosFileTransfer 5.C0osFileTransfer_FileIterator(3)