---
name: "CosFileTransfer_FileIterator"
section: "3erl"
platform: "linux"
package: "erlang-manpages"
version: "1:19.2.1+dfsg-2+deb9u3"
release: "Debian 9 (Stretch)"
platforms: ["linux"]
url: "https://new.carta.tech/CosFileTransfer_FileIterator"
---

# CosFileTransfer\_FileIterator(3erl)

This module implements the OMG CosFileTransfer::FileIterator interface.

## 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.