1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<!-- This document was generated using DocBuilder 3.3.2 -->
<HTML>
<HEAD>
<TITLE>CosFileTransfer_FileIterator</TITLE>
<SCRIPT type="text/javascript" src="../../../../doc/erlresolvelinks.js">
</SCRIPT>
<STYLE TYPE="text/css">
<!--
.REFBODY { margin-left: 13mm }
.REFTYPES { margin-left: 8mm }
-->
</STYLE>
</HEAD>
<BODY BGCOLOR="#FFFFFF" TEXT="#000000" LINK="#0000FF" VLINK="#FF00FF"
ALINK="#FF0000">
<!-- refpage -->
<CENTER>
<A HREF="http://www.erlang.se">
<IMG BORDER=0 ALT="[Ericsson AB]" SRC="min_head.gif">
</A>
<H1>CosFileTransfer_FileIterator</H1>
</CENTER>
<H3>MODULE</H3>
<DIV CLASS=REFBODY>
CosFileTransfer_FileIterator
</DIV>
<H3>MODULE SUMMARY</H3>
<DIV CLASS=REFBODY>
This module implements the OMG CosFileTransfer::FileIterator interface.
</DIV>
<H3>DESCRIPTION</H3>
<DIV CLASS=REFBODY>
<P> To get access to the record definitions for the structures use:<BR>
<CODE>-include_lib("cosFileTransfer/include/*.hrl").</CODE>
</DIV>
<H3>EXPORTS</H3>
<P><A NAME="next_one/1"><STRONG><CODE>next_one(Iterator) -> Return</CODE></STRONG></A><BR>
<DIV CLASS=REFBODY><P>Types:
<DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Iterator = #objref</CODE></STRONG><BR>
<STRONG><CODE>Return = {boolean(), #'CosFileTransfer_FileWrapper'{the_file = File
file_type = Type}}</CODE></STRONG><BR>
<STRONG><CODE>File = #objref</CODE></STRONG><BR>
<STRONG><CODE>Type = nfile | ndirectory</CODE></STRONG><BR>
</DIV>
</DIV>
<DIV CLASS=REFBODY>
<P> This opertion returns true if a <CODE>FileWrapper</CODE> exists at the
current position and the out parameter contains a valid <CODE>File</CODE>
reference. If false is returned the out parameter is a non-valid
<CODE>FileWrapper</CODE>.
</DIV>
<P><A NAME="next_n/2"><STRONG><CODE>next_n(Iterator, Max) -> Return</CODE></STRONG></A><BR>
<DIV CLASS=REFBODY><P>Types:
<DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Iterator = #objref</CODE></STRONG><BR>
<STRONG><CODE>Max = unsigned long()</CODE></STRONG><BR>
<STRONG><CODE>Return = {boolean(), FileList}</CODE></STRONG><BR>
<STRONG><CODE>FileList = [#'CosFileTransfer_FileWrapper'{the_file = File
file_type = Type}]</CODE></STRONG><BR>
<STRONG><CODE>File = #objref</CODE></STRONG><BR>
<STRONG><CODE>Type = nfile | ndirectory</CODE></STRONG><BR>
</DIV>
</DIV>
<DIV CLASS=REFBODY>
<P> This operation returns true if the requested number of <CODE>FileWrappers</CODE>
can be delivered and there are additional <CODE>FileWrappers</CODE>. If false is
returned a list, of length <CODE>Max</CODE> or less, containing the last valid
<CODE>FileWrappers</CODE> associated with the target object.
</DIV>
<P><A NAME="destroy/1"><STRONG><CODE>destroy(Iterator) -> ok</CODE></STRONG></A><BR>
<DIV CLASS=REFBODY><P>Types:
<DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Iterator = #objref</CODE></STRONG><BR>
</DIV>
</DIV>
<DIV CLASS=REFBODY>
<P> This operation terminates the target object.
</DIV>
<H3>AUTHORS</H3>
<DIV CLASS=REFBODY>
support - support@erlang.ericsson.se<BR>
</DIV>
<CENTER>
<HR>
<SMALL>cosFileTransfer 1.1.2<BR>
Copyright © 1991-2004
<A HREF="http://www.erlang.se">Ericsson AB</A><BR>
</SMALL>
</CENTER>
</BODY>
</HTML>
|