1CosFileTransfer_FileTransferESrelsasnigonM(o3d)uleCDoesfFiinlietTiroannsfer_FileTransferSession(3)
2
3
4

NAME

6       CosFileTransfer_FileTransferSession  -  This  module implements the OMG
7       CosFileTransfer::FileTransferSession interface.
8

DESCRIPTION

10       To get access to the record definitions for the structures use:
11       -include_lib("cosFileTransfer/include/*.hrl").
12

EXPORTS

14       '_get_protocols_supported'(FTS) -> Return
15
16              Types:
17
18                 FTS = #objref
19                 Return      =      [#'CosFileTransfer_ProtocolSupport'{proto‐
20                 col_name=Type, addresses=[Address]}]
21                 Type = Address = string()
22
23              This  read only attribute returns the protocols supported by the
24              target object.
25
26       set_directory(FTS, Directory) -> Return
27
28              Types:
29
30                 FTS = Directory = #objref
31                 Return = ok | {'EXCEPTION, E}
32
33              Invoking this operation will change the current  working  direc‐
34              tory  of  the target object's associated file system. If fail to
35              do so the appropriate exception is raised.
36
37       create_file(FTS, FileNameList) -> Return
38
39              Types:
40
41                 FTS = #objref
42                 FileNameList = [string()]
43                 Return = File | {'EXCEPTION, E}
44                 File = #objref
45
46              This operation creates a File Object representing a  file  which
47              may  or  may  not exist. For this operation to be independent of
48              the working directory the supplied FileNameList  must  represent
49              the absolute name.
50
51       create_directory(FTS, FileNameList) -> Return
52
53              Types:
54
55                 FTS = #objref
56                 FileNameList = [string()]
57                 Return = Directory | {'EXCEPTION, E}
58                 Directory = #objref
59
60              This operation creates a new directory in the target objects as‐
61              sociated file systems domain. If fail to do so an  exception  is
62              raised  but,  if successful, a Directory object representing the
63              new directory is returned.
64
65       get_file(FTS, FileNameList) -> Return
66
67              Types:
68
69                 FTS = #objref
70                 FileNameList = [string()]
71                 Return = FileWrapper | {'EXCEPTION, E}
72                 FileWrapper = #'CosFileTransfer_FileWrapper'{the_file =  File
73                 file_type = Type}
74                 File = #objref
75                 Type = nfile | ndirectory
76
77              This operation, creates a FileWrapper which represents a file or
78              directory, and should be independent of the  working  Directory,
79              i.e.,  a  full path name must be supplied. Furthermore, the file
80              or directory represented by the FileNameList must exist.
81
82       delete(FTS, File) -> Return
83
84              Types:
85
86                 FTS = File = #objref
87                 Return = ok | {'EXCEPTION', E}
88
89              This operation removes the file or directory, represented by the
90              File  object, from the target objects associated file system. If
91              it is a non-empty directory or non-existing file or directory an
92              exception is raised.
93
94       transfer(FTS, SourceFile, DestinationFile) -> Return
95
96              Types:
97
98                 FTS = SourceFile = DestinationFile = #objref
99                 Return = ok | {'EXCEPTION', E}
100
101              If  the  target  object's  and  the DestinationFile's associated
102              FileTransferSession's support the same protocol(s)  this  opera‐
103              tion  will  copy the file represented by the SourceFile from the
104              target object's file system to a file in the  destination  File‐
105              TransferSession's  file  system.  The file is represented by the
106              DestinationFile object and may not exist. This operation must be
107              invoked  on  the FileTransferSession associated with the Source‐
108              File object.
109
110       append(FTS, SourceFile, DestinationFile) -> Return
111
112              Types:
113
114                 FTS = SourceFile = DestinationFile = #objref
115                 Return = ok | {'EXCEPTION', E}
116
117              This operation behaves almost like the transfer/3 operation. The
118              difference  is  that  the  DestinationFile  must exist since the
119              SourceFile will be appended to the DestinationFile.
120
121              Currently, it is not possible to use  this  operation  when  the
122              target object represents FTP.
123
124       insert(FTS, SourceFile, DestinationFile, Offset) -> Return
125
126              Types:
127
128                 FTS = SourceFile = DestinationFile = #objref
129                 Offset = long()
130                 Return = ok | {'EXCEPTION', E}
131
132              This  operation  behaves almost like the append/3 operation. The
133              difference is that the SourceFile will be inserted into the Des‐
134              tinationFile Offset bytes from the start of the file.
135
136              Currently,  it  is  not  possible to use this operation when the
137              target object represents FTP.
138
139       logout(FTS) -> ok
140
141              Types:
142
143                 FTS = #objref
144
145              This operation terminates the target object and closes the  con‐
146              nection to the file system it represents.
147
148
149
150Ericsson AB                   cosFileTranCsofseFril5e.T1ransfer_FileTransferSession(3)