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
|
.TH CosFileTransfer_Directory 3 "cosFileTransfer 1.1.5" "Ericsson AB" "ERLANG MODULE DEFINITION"
.SH MODULE
CosFileTransfer_Directory \- This module implements the OMG CosFileTransfer::Directory interface\&.
.SH DESCRIPTION
.LP
To get access to the record definitions for the structures use:
.br
\fI-include_lib("cosFileTransfer/include/*\&.hrl")\&.\fR
.LP
This module also exports the functions described in:
.RS 2
.TP 2
*
CosFileTransfer_File
.TP 2
*
CosPropertyService_PropertySetDef in the cosProperty application\&.
.RE
.SH EXPORTS
.LP
.B
list(Directory, Max) -> Return
.br
.RS
.TP
Types
Directory = #objref
.br
Return = {ok, FileList, FileIterator}
.br
FileList = [File]
.br
File = FileIterator = #objref
.br
.RE
.RS
.LP
This operation returns a list, of length \fIMax\fR or less, containing Object References representing files or directories contained within the target Directory\&. If the amount of objects found is less than \fIMax\fR the returned Iterator will be a \fINIL\fR object\&.
.RE
|