Menu
▾
▴
[Sandweb-commit] CVS: sandweb/doc/API/File Unix.txt,NONE,1.1
|
From: Rob H. <for...@us...> - 2002-10-17 07:30:51
|
Update of /cvsroot/sandweb/sandweb/doc/API/File
In directory usw-pr-cvs1:/tmp/cvs-serv27191/File
Added Files:
Unix.txt
Log Message:
started API docs, these all need to be filled out but they now
have the basic structure
--- NEW FILE ---
# lib/SandWeb/File/Unix.pm
#
# This class handles all file viewing and operations on Unix systems.
# It is only intended to be called by the File class.
--------------------------------------------------------------------------------
METHOD
new
SYNOPSIS
DESCRIPTION
PARAMETERS
parameter (type: string) (required)
Default: 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.
get_owner
--------------------------------------------------------------------------------
METHOD
methodname
SYNOPSIS
DESCRIPTION
PARAMETERS
parameter (type: string) (required)
Default: 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.
get_group
--------------------------------------------------------------------------------
METHOD
methodname
SYNOPSIS
DESCRIPTION
PARAMETERS
parameter (type: string) (required)
Default: 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.
get_filename
--------------------------------------------------------------------------------
METHOD
methodname
SYNOPSIS
DESCRIPTION
PARAMETERS
parameter (type: string) (required)
Default: 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.
get_location
--------------------------------------------------------------------------------
METHOD
methodname
SYNOPSIS
DESCRIPTION
PARAMETERS
parameter (type: string) (required)
Default: 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.
get_permissions
--------------------------------------------------------------------------------
METHOD
methodname
SYNOPSIS
DESCRIPTION
PARAMETERS
parameter (type: string) (required)
Default: 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.
get_file_type
--------------------------------------------------------------------------------
METHOD
methodname
SYNOPSIS
DESCRIPTION
PARAMETERS
parameter (type: string) (required)
Default: 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.
get_size
--------------------------------------------------------------------------------
METHOD
methodname
SYNOPSIS
DESCRIPTION
PARAMETERS
parameter (type: string) (required)
Default: 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.
get_age
--------------------------------------------------------------------------------
METHOD
methodname
SYNOPSIS
DESCRIPTION
PARAMETERS
parameter (type: string) (required)
Default: 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.
upload
--------------------------------------------------------------------------------
METHOD
methodname
SYNOPSIS
DESCRIPTION
PARAMETERS
parameter (type: string) (required)
Default: 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.
download
--------------------------------------------------------------------------------
METHOD
methodname
SYNOPSIS
DESCRIPTION
PARAMETERS
parameter (type: string) (required)
Default: 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.
exists
--------------------------------------------------------------------------------
METHOD
methodname
SYNOPSIS
DESCRIPTION
PARAMETERS
parameter (type: string) (required)
Default: 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.
create_file
--------------------------------------------------------------------------------
METHOD
methodname
SYNOPSIS
DESCRIPTION
PARAMETERS
parameter (type: string) (required)
Default: 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.
create_folder
--------------------------------------------------------------------------------
METHOD
methodname
SYNOPSIS
DESCRIPTION
PARAMETERS
parameter (type: string) (required)
Default: 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.
delete
--------------------------------------------------------------------------------
METHOD
methodname
SYNOPSIS
DESCRIPTION
PARAMETERS
parameter (type: string) (required)
Default: 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.
delete_folder
--------------------------------------------------------------------------------
METHOD
methodname
SYNOPSIS
DESCRIPTION
PARAMETERS
parameter (type: string) (required)
Default: 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.
copy
--------------------------------------------------------------------------------
METHOD
methodname
SYNOPSIS
DESCRIPTION
PARAMETERS
parameter (type: string) (required)
Default: 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.
rename
--------------------------------------------------------------------------------
METHOD
methodname
SYNOPSIS
DESCRIPTION
PARAMETERS
parameter (type: string) (required)
Default: 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.
file_read
--------------------------------------------------------------------------------
METHOD
methodname
SYNOPSIS
DESCRIPTION
PARAMETERS
parameter (type: string) (required)
Default: 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.
file_write
--------------------------------------------------------------------------------
METHOD
methodname
SYNOPSIS
DESCRIPTION
PARAMETERS
parameter (type: string) (required)
Default: 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.
get_file_commands
--------------------------------------------------------------------------------
METHOD
methodname
SYNOPSIS
DESCRIPTION
PARAMETERS
parameter (type: string) (required)
Default: 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.
_do_file_write
--------------------------------------------------------------------------------
METHOD
methodname
SYNOPSIS
DESCRIPTION
PARAMETERS
parameter (type: string) (required)
Default: 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.
_do_file_read
--------------------------------------------------------------------------------
METHOD
methodname
SYNOPSIS
DESCRIPTION
PARAMETERS
parameter (type: string) (required)
Default: 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.
_shell
--------------------------------------------------------------------------------
METHOD
methodname
SYNOPSIS
DESCRIPTION
PARAMETERS
parameter (type: string) (required)
Default: 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.
|
