File: file.cat

package info (click to toggle)
scilab 2.6-4
  • links: PTS
  • area: non-free
  • in suites: woody
  • size: 54,632 kB
  • ctags: 40,267
  • sloc: ansic: 267,851; fortran: 166,549; sh: 10,005; makefile: 4,119; tcl: 1,070; cpp: 233; csh: 143; asm: 135; perl: 130; java: 39
file content (114 lines) | stat: -rw-r--r-- 4,245 bytes parent folder | download
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
file             Scilab Group             Scilab Function              file
NAME
   file - file management
  
CALLING SEQUENCE
 [unit [,err]]=file('open', file-name [,status] [,access [,recl]] [,format])
 file(action,unit)
 [units [,typ [,nams [,mod [,swap]]]]] = file([unit])
PARAMETERS
 file-name  : string, file name of the file to be opened
            
 status     : string, The status of the file to be opened
            
           "new"         : file must not exist new file (default)
                         
           "old"         : file must already exists.
                         
           "unknown"     : unknown status
                         
           "scratch"     : file is to be deleted at end of session
                         
 access     : string, The type of access to the file
            
           "sequential"  : sequential access (default)
                         
           "direct"      : direct access.
                         
 format     : string,
            
           "formatted"   : for a  formatted file (default)
                         
           "unformatted" : binary record.
                         
 recl       : integer,is the size of records in bytes when access="direct"
            
 unit       : integer, logical unit descriptor of the opened file
            
 units      : integer vector, logical unit descriptor of the opened files.
            Units 1 5 and 6 are reserved by the system for history file ,
            input and output devices.
            
 typs       : Character string vector, type (C or Fortran) of opened
            files.
            
 nams       : Character string vector, pathnames of opened files.
            
 mod        : file opening mode. Formed by three digits abc
            
               a    : 0 stands for formatted and 1 for unformatted
                    (binary)
                    
               b    : 0 stands for sequential acces and 1 for direct
                    access
                    
               c    : 0 stands for  "new", 1 for "old", 2 for "scratch"
                    and 3 for "unknown"
                    
               a    : is 1 if file has been opened with a "b" (binary)
                    mode
                    
               b    : is 1 if file has been opened with a "+" (updating)
                    mode
                    
               c    : 1 stands for "r" (read), 2 stands for "w" (write)
                    and 3 for "a" (append)
                    
 swap       : automatic swap switch. swap=1 if automatic swap is on. swap
            is always 0 for Fortran files.
            
 err        : integer, error message number (see error), if open fails. If
            err is omitted an error message is issued.
            
 action     : is one of the following strings:
            
           "close"       : closes the file(s) given by the logical unit
                         descriptors given in units
                         
           "rewind"      : puts the pointer at beginning of file
                         
           "backspace"   : puts the pointer at beginning of last record.
                         
           "last"        : puts the pointer after last record.
                         
DESCRIPTION
   selects a logical unit unit and manages the file file-name.
  
   [unit [,err]]=file('open', file-name [,status] [,access [,recl]]
  [,format]) allows to open a file with specified properties and to get the
  associated unit number unit. This unit number may be used for further
  actions on this file or as file descriptor in read, write, readb,
  writb,save, load function calls.
  
   file(action,unit) allows to close the file , or move the current file
  pointer .
  
   file() returns the logical unit descriptors of the opened files. So
  file('close',file() ) closes all user opened files (C or Fortran type). 
  
EXAMPLE
 u=file('open',TMPDIR+'/foo','unknown')
 for k=1:4
   a=rand(1,4)
   write(u,a)
 end
 file('rewind',u)
 x=read(u,2,4)
 file('close',u)
 //
 u1=file('open',TMPDIR+'/foo','unknown')
 u2=mopen(TMPDIR+'/foo1','wb')
 [units,typs,nams]=file()
SEE ALSO
   save, load, write, read, writb, readb, xgetfile, mopen, mclose