CDBFile Class Reference

#import <CDBFile.h>

Inherited by CDBReader, and CDBWriter.

List of all members.

---

Detailed Description

Abstract base class for CDB files.

Public Member Functions
(BOOL)	- open
	Opens the file.
(BOOL)	- close
	Closes the file.
(BOOL)	- deleteFile
	Deletes the file.
(void)	- clearError
	Clears the error property back to nil, without closing the file.
Properties
readonly NSString *	file
	The path of the file, as given to the -initWithFile: method.
readonly int	fileDescriptor
	The underlying file descriptor, while the file is open.
readonly BOOL	isOpen
	Is the file open?
readonly NSError *	error
	Any error will be stored in this property.

---

Member Function Documentation

- (BOOL) open

Opens the file.

Returns:

YES on success, no on failure; in the latter case, check, the error property.

- (BOOL) close

Closes the file.

Returns:

YES on success, no on failure; in the latter case, check, the error property.

- (BOOL) deleteFile

Deletes the file.

Don't call this while the file is open.

- (void) clearError

Clears the error property back to nil, without closing the file.

---

Property Documentation

- (readonly NSString*) file

The path of the file, as given to the -initWithFile: method.

- (readonly int) fileDescriptor

The underlying file descriptor, while the file is open.

- (NSError *) error

Any error will be stored in this property.

It won't be cleared back to nil until -clearError or -close is called.

---

The documentation for this class was generated from the following files:

• CDBFile.h
• CDBFile.m

---