From 84adefa331c4159d432d22840663c38f155cd4c1 Mon Sep 17 00:00:00 2001 From: Erlang/OTP Date: Fri, 20 Nov 2009 14:54:40 +0000 Subject: The R13B03 release. --- .../doc/src/CosFileTransfer_FileIterator.xml | 86 ++++++++++++++++++++++ 1 file changed, 86 insertions(+) create mode 100644 lib/cosFileTransfer/doc/src/CosFileTransfer_FileIterator.xml (limited to 'lib/cosFileTransfer/doc/src/CosFileTransfer_FileIterator.xml') diff --git a/lib/cosFileTransfer/doc/src/CosFileTransfer_FileIterator.xml b/lib/cosFileTransfer/doc/src/CosFileTransfer_FileIterator.xml new file mode 100644 index 0000000000..c848a9830d --- /dev/null +++ b/lib/cosFileTransfer/doc/src/CosFileTransfer_FileIterator.xml @@ -0,0 +1,86 @@ + + + + +
+ + 20002009 + Ericsson AB. All Rights Reserved. + + + The contents of this file are subject to the Erlang Public License, + Version 1.1, (the "License"); you may not use this file except in + compliance with the License. You should have received a copy of the + Erlang Public License along with this software. If not, it can be + retrieved online at http://www.erlang.org/. + + Software distributed under the License is distributed on an "AS IS" + basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See + the License for the specific language governing rights and limitations + under the License. + + + + CosFileTransfer_­FileIterator + ..._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.

+ + + + + + -- cgit v1.2.3