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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<!-- This document was generated using DocBuilder 3.3.2 -->
<HTML>
<HEAD>
<TITLE>CosFileTransfer_FileTransferSession</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_FileTransferSession</H1>
</CENTER>
<H3>MODULE</H3>
<DIV CLASS=REFBODY>
CosFileTransfer_FileTransferSession
</DIV>
<H3>MODULE SUMMARY</H3>
<DIV CLASS=REFBODY>
This module implements the OMG CosFileTransfer::FileTransferSession 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="'_get_protocols_supported'/1"><STRONG><CODE>'_get_protocols_supported'(FTS) -> Return</CODE></STRONG></A><BR>
<DIV CLASS=REFBODY><P>Types:
<DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>FTS = #objref</CODE></STRONG><BR>
<STRONG><CODE>Return = [#'CosFileTransfer_ProtocolSupport'{protocol_name=Type,
addresses=[Address]}]</CODE></STRONG><BR>
<STRONG><CODE>Type = Address = string()</CODE></STRONG><BR>
</DIV>
</DIV>
<DIV CLASS=REFBODY>
<P> This read only attribute returns the protocols supported by the
target object.
</DIV>
<P><A NAME="set_directory/2"><STRONG><CODE>set_directory(FTS, Directory) -> Return</CODE></STRONG></A><BR>
<DIV CLASS=REFBODY><P>Types:
<DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>FTS = Directory = #objref</CODE></STRONG><BR>
<STRONG><CODE>Return = ok | {'EXCEPTION, E}</CODE></STRONG><BR>
</DIV>
</DIV>
<DIV CLASS=REFBODY>
<P> Invoking this operation will change the current working directory of
the target object's associated file system. If fail to do so the
appropriate exception is raised.
</DIV>
<P><A NAME="create_file/2"><STRONG><CODE>create_file(FTS, FileNameList) -> Return</CODE></STRONG></A><BR>
<DIV CLASS=REFBODY><P>Types:
<DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>FTS = #objref</CODE></STRONG><BR>
<STRONG><CODE>FileNameList = [string()]</CODE></STRONG><BR>
<STRONG><CODE>Return = File | {'EXCEPTION, E}</CODE></STRONG><BR>
<STRONG><CODE>File = #objref</CODE></STRONG><BR>
</DIV>
</DIV>
<DIV CLASS=REFBODY>
<P> This operation creates a <CODE>File</CODE> Object representing a file which
may or may not exist.
For this operation to be independent of the working cirectory the
supplied <CODE>FileNameList</CODE> must represent the absolute name.
</DIV>
<P><A NAME="create_directory/2"><STRONG><CODE>create_directory(FTS, FileNameList) -> Return</CODE></STRONG></A><BR>
<DIV CLASS=REFBODY><P>Types:
<DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>FTS = #objref</CODE></STRONG><BR>
<STRONG><CODE>FileNameList = [string()]</CODE></STRONG><BR>
<STRONG><CODE>Return = Directory | {'EXCEPTION, E}</CODE></STRONG><BR>
<STRONG><CODE>Directory = #objref</CODE></STRONG><BR>
</DIV>
</DIV>
<DIV CLASS=REFBODY>
<P> This operation creates a new directory in the target objects associated
file systems domain. If fail to do so an exception is raised but,
if successfull, a <CODE>Directory</CODE> object representing the new
directory is returned.
</DIV>
<P><A NAME="get_file/2"><STRONG><CODE>get_file(FTS, FileNameList) -> Return</CODE></STRONG></A><BR>
<DIV CLASS=REFBODY><P>Types:
<DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>FTS = #objref</CODE></STRONG><BR>
<STRONG><CODE>FileNameList = [string()]</CODE></STRONG><BR>
<STRONG><CODE>Return = FileWrapper | {'EXCEPTION, E}</CODE></STRONG><BR>
<STRONG><CODE>FileWrapper = #'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, creates a <CODE>FileWrapper</CODE> which represents a file or directory, and
should be independent of the working Directory,
i.e., a full path name must be supplied. Furthermore, the file or
directory represented by the <CODE>FileNameList</CODE> must exist.
</DIV>
<P><A NAME="delete/2"><STRONG><CODE>delete(FTS, File) -> Return</CODE></STRONG></A><BR>
<DIV CLASS=REFBODY><P>Types:
<DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>FTS = File = #objref</CODE></STRONG><BR>
<STRONG><CODE>Return = ok | {'EXCEPTION', E}</CODE></STRONG><BR>
</DIV>
</DIV>
<DIV CLASS=REFBODY>
<P> This operation removes the file or directory, represented by the <CODE>File</CODE>
object, from the target objects associated file system. If it is a non-empty
directory or non-existing file or directory an exception is raised.
</DIV>
<P><A NAME="transfer/3"><STRONG><CODE>transfer(FTS, SourceFile, DestinationFile) -> Return</CODE></STRONG></A><BR>
<DIV CLASS=REFBODY><P>Types:
<DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>FTS = SourceFile = DestinationFile = #objref</CODE></STRONG><BR>
<STRONG><CODE>Return = ok | {'EXCEPTION', E}</CODE></STRONG><BR>
</DIV>
</DIV>
<DIV CLASS=REFBODY>
<P> If the target object's and the <CODE>DestinationFile's</CODE> associated
<CODE>FileTransferSession's</CODE> support the same protocol(s) this operation
will copy the file represented by the <CODE>SourceFile</CODE> from the target
object's file system to a file in the destination
<CODE>FileTransferSession's</CODE> file system. The file is represented by the
<CODE>DestinationFile</CODE> object and may not exist.
This operation must be invoked on the <CODE>FileTransferSession</CODE>
associated with the <CODE>SourceFile</CODE> object.
</DIV>
<P><A NAME="append/3"><STRONG><CODE>append(FTS, SourceFile, DestinationFile) -> Return</CODE></STRONG></A><BR>
<DIV CLASS=REFBODY><P>Types:
<DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>FTS = SourceFile = DestinationFile = #objref</CODE></STRONG><BR>
<STRONG><CODE>Return = ok | {'EXCEPTION', E}</CODE></STRONG><BR>
</DIV>
</DIV>
<DIV CLASS=REFBODY>
<P> This operation behaves almost like the <CODE>transfer/3</CODE> operation. The
difference is that the <CODE>DestinationFile</CODE> must exist since the
<CODE>SourceFile</CODE> will be appended to the <CODE>DestinationFile</CODE>.
<P>Currently, it is not possible to use this operation when the target
object represents FTP.
</DIV>
<P><A NAME="insert/4"><STRONG><CODE>insert(FTS, SourceFile, DestinationFile, Offset) -> Return</CODE></STRONG></A><BR>
<DIV CLASS=REFBODY><P>Types:
<DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>FTS = SourceFile = DestinationFile = #objref</CODE></STRONG><BR>
<STRONG><CODE>Offset = long()</CODE></STRONG><BR>
<STRONG><CODE>Return = ok | {'EXCEPTION', E}</CODE></STRONG><BR>
</DIV>
</DIV>
<DIV CLASS=REFBODY>
<P> This operation behaves almost like the <CODE>append/3</CODE> operation. The
difference is that the <CODE>SourceFile</CODE> will be inserted into the
<CODE>DestinationFile</CODE> <CODE>Offset</CODE> bytes from the start of the file.
<P>Currently, it is not possible to use this operation when the target
object represents FTP.
</DIV>
<P><A NAME="logout/1"><STRONG><CODE>logout(FTS) -> ok</CODE></STRONG></A><BR>
<DIV CLASS=REFBODY><P>Types:
<DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>FTS = #objref</CODE></STRONG><BR>
</DIV>
</DIV>
<DIV CLASS=REFBODY>
<P> This opertion terminates the target object and closes the connection
to the file system it represents.
</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>
|
