20002013 Ericsson AB. All Rights Reserved. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. CosFileTransfer_FileIterator 2000-11-09 PA1
CosFileTransfer_FileIterator This module implements the OMG CosFileTransfer::FileIterator interface.

To get access to the record definitions for the structures use:

-include_lib("cosFileTransfer/include/*.hrl").

 next_one(Iterator) -> Return Return the next FileWrapperand a boolean which indicate whether the FileWrapperis valid or not. 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 Return a list, of length Maxor less, containing FileWrappersand a boolean which indicates if more FileWrappersexists 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 Terminate the target object Iterator = #objref

This operation terminates the target object.