Update of /cvsroot/sandweb/sandweb/doc/API
In directory usw-pr-cvs1:/tmp/cvs-serv16902/doc/API
Modified Files:
File.txt
Log Message:
* fixed weird formatting of view and edit templates
* updated File.txt documentation. I decided to document the
location/file behavior as it *should* work; the problem I was
seeing before is actually sandweb.cgi's problem. It needs an
extra routine to support the correct behavior ( the filename
needs to be extracted from the absolute or relative path ).
Index: File.txt
===================================================================
RCS file: /cvsroot/sandweb/sandweb/doc/API/File.txt,v
retrieving revision 1.1
retrieving revision 1.2
diff -U2 -r1.1 -r1.2
--- File.txt 2001/11/15 20:46:40 1.1
+++ File.txt 2001/11/22 08:29:00 1.2
@@ -29,6 +29,6 @@
filename (type: string) (required)
- This contains the path to the filename from the
- user's sandbox ( including the filename itself ).
+ This contains the full name of the file, as far as the
+ file system is concerned.
Default: none.
@@ -109,6 +109,5 @@
DESCRIPTION
- Returns the path from the user's sandbox and
- the full name of the file.
+ Returns the full name of the file.
PARAMETERS
@@ -138,6 +137,5 @@
Returns the full ( absolute or relative ) path
- to the user's sandbox, as far as the file system
- is concerned.
+ to the file.
PARAMETERS
@@ -197,4 +195,59 @@
this is. Type returned one of : Binary, Text,
Directory or Unknown.
+
+PARAMETERS
+
+ None.
+
+RETURN CODES
+
+ 1 = The operation completed successfully.
+
+ 0 = This means that the method got an error proccessing your request.
+ Perhaps an invalid parameter?
+
+ -1 = This return value means that there was not sufficient permision to
+ read the files specified, or they did not exist.
+
+--------------------------------------------------------------------------------
+
+METHOD
+ get_size
+
+SYNOPSIS
+
+ my $file_size = $file->get_size();
+
+DESCRIPTION
+
+ Returns the size of the file, in bytes.
+
+PARAMETERS
+
+ None.
+
+RETURN CODES
+
+ 1 = The operation completed successfully.
+
+ 0 = This means that the method got an error proccessing your request.
+ Perhaps an invalid parameter?
+
+ -1 = This return value means that there was not sufficient permision to
+ read the files specified, or they did not exist.
+
+--------------------------------------------------------------------------------
+
+METHOD
+ get_mtime
+
+SYNOPSIS
+
+ my $mtime = $file->get_mtime();
+
+DESCRIPTION
+
+ Returns the date of the last modification to this
+ file, in UNIX time ( seconds since 01-01-1970 UTC ).
PARAMETERS
|
