Man pages sections > man3 > CosFileTransfer_FileIterator

CosFileTransfer_FileIterator - This module implements the OMG

CosFileTransfer_FileIterator(3erl) Erlang Module Definition CosFileTransfer_FileIterator(3erl)

NAME

CosFileTransfer_FileIterator - This module implements the OMG CosFileTransfer::FileIterator interface.

DESCRIPTION

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

EXPORTS

next_one(Iterator) -> Return
 
Types:
 
Iterator = #objref
 
Return = {boolean(), #'CosFileTransfer_FileWrapper'{the_file = File file_type = Type}}
 
File = #objref
 
Type = nfile | ndirectory
 
This operation returns true if a FileWrapper exists at the current position and the out parameter contains a valid File reference. If false is returned the out parameter is a non-valid FileWrapper.
 
next_n(Iterator, Max) -> Return
 
Types:
 
Iterator = #objref
 
Max = unsigned long()
 
Return = {boolean(), FileList}
 
FileList = [#'CosFileTransfer_FileWrapper'{the_file = File file_type = Type}]
 
File = #objref
 
Type = nfile | ndirectory
 
This operation returns true if the requested number of FileWrappers can be delivered and there are additional FileWrappers. If false is returned a list, of length Max or less, containing the last valid FileWrappers associated with the target object.
 
destroy(Iterator) -> ok
 
Types:
 
Iterator = #objref
 
This operation terminates the target object.
cosFileTransfer 1.2.1 Ericsson AB