---

recls/Python
[recls]

The recls/Python mapping. More...

Compounds
class	Entry
	A file object. More...
class	FileSearch
	This class provides file-system searching. More...
class	FtpSearch
	This class provides FTP searching on an internet host. More...
Functions
Entry	stat (string path, int flags=0)
	retrieves the Entry information for the given path/flags
FileSearch	filesearch (string path, string pattern, int flags=0)
	Searches a directory for entries, according to the given pattern and (optional) flags.
FtpSearch	ftpsearch (string path, string pattern, int flags=0)
	Searches an FTP host for entries, according to the given pattern and (optional) flags.
Constants
string	RECLS_VERSION
	The recls version from which this Python mapping was made.
string	__recls_version__
	The recls version from which this Python mapping was made.
string	VERSION
	The version of this Python mapping.
string	__version__
	The version of this Python mapping.
int	FILES
	Include files in search.
int	DIRECTORIES
	Include directories in search.
int	LINKS
	Include links in search.
int	DEVICES
	Include devices in search.
int	RECURSIVE
	Searches given directory and all sub-directories.
int	NO_FOLLOW_LINKS
	Does not expand links.
int	DIRECTORY_PARTS
	Fills out the directory parts.
int	DETAILS_LATER
	Does not fill out anything other than the path.
int	PASSIVE_FTP
	Passive mode in FTP.

---

Detailed Description

The recls/Python mapping.

This mapping contains the classes - FileSearch FtpSearch and Entry - which provide a Python object model wrapping over the recls API, handling resource management, and providing easy-to-use object access to the search results.

---

Function Documentation

FileSearch filesearch (  string    path, string    pattern, int    flags = 0 )

Searches a directory for entries, according to the given pattern and (optional) flags.

FtpSearch ftpsearch (  string    path, string    pattern, int    flags = 0 )

Searches an FTP host for entries, according to the given pattern and (optional) flags.

Entry stat (  string    path, int    flags = 0 )

retrieves the Entry information for the given path/flags

---

Variable Documentation

string __recls_version__

The recls version from which this Python mapping was made.

string __version__

The version of this Python mapping.

int DETAILS_LATER

Does not fill out anything other than the path.

int DEVICES

Include devices in search. Not currently supported

int DIRECTORIES

Include directories in search.

int DIRECTORY_PARTS

Fills out the directory parts.

int FILES

Include files in search. Included by default if none specified

int LINKS

Include links in search. Ignored in Win32

int NO_FOLLOW_LINKS

Does not expand links.

int PASSIVE_FTP

Passive mode in FTP.

string RECLS_VERSION

The recls version from which this Python mapping was made.

int RECURSIVE

Searches given directory and all sub-directories.

string VERSION

The version of this Python mapping.

recls Library documentation © Synesis Software Pty Ltd, 2001-2005