< PLResultSet > Protocol Reference

#import <PLResultSet.h>

List of all members.

Public Member Functions
(BOOL)	- next
(void)	- close
(int)	- columnIndexForName:
(int32_t)	- intForColumnIndex:
(int32_t)	- intForColumn:
(NSString *)	- stringForColumnIndex:
(NSString *)	- stringForColumn:
(int64_t)	- bigIntForColumnIndex:
(int64_t)	- bigIntForColumn:
(BOOL)	- isNullForColumnIndex:
(BOOL)	- isNullForColumn:
(BOOL)	- boolForColumn:
(BOOL)	- boolForColumnIndex:
(float)	- floatForColumn:
(float)	- floatForColumnIndex:
(double)	- doubleForColumn:
(double)	- doubleForColumnIndex:
(NSDate *)	- dateForColumn:
(NSDate *)	- dateForColumnIndex:
(NSData *)	- dataForColumn:
(NSData *)	- dataForColumnIndex:

---

Detailed Description

Represents a set of results returned by an SQL query.

---

Member Function Documentation

- (BOOL) next

Move the result cursor to the next available row. If no further rows are available, returns NO.

Returns:

YES if the cursor was moved to the next row, NO if no further rows were available.

- (void) close

Close the result set, and return any held database resources. After calling, NO OTHER METHODS may be called on the result set.

As PLResultSet objects may be placed into autorelease pools, with indeterminate release of database resources, this method should be used to ensure that the database connection remains usable once finished with a result set.

Failure to call close will not result in any memory leaks, but may prevent further use of the database connection (until the result set is released).

- (int) columnIndexForName:

(NSString *)

name

Map the given column name to a column index. Will throw NSException if the column name is unknown.

Parameters:

name

Name of the column.

Returns:

Returns the index of the column name, or throws an NSException if the column can not be found.

- (int32_t) intForColumnIndex:

(int)

columnIdx

Return the integer value of the given column index from the current result row.

Will throw NSException if the column index is out of range, or if the column value is NULL.

- (int32_t) intForColumn:

(NSString *)

columnName

Return the integer value of the named column from the current result row.

Will throw NSException if the column name is unknown, or if the column value is NULL.

- (NSString *) stringForColumnIndex:

(int)

columnIndex

Return the string value of the given column index from the current result row.

Will throw NSException if the column index is out of range, or if the column value is NULL.

- (NSString *) stringForColumn:

(NSString *)

columnName

Return the string value of the named column from the current result row.

Will throw NSException if the column name is unknown, or if the column value is NULL.

- (int64_t) bigIntForColumnIndex:

(int)

columnIndex

Returns the 64 bit big integer (long) value of the given column index the current result row.

Will throw NSException if the column index is out of range, or if the column value is NULL.

- (int64_t) bigIntForColumn:

(NSString *)

columnName

Returns the 64 bit big integer (long) value of the named column from the current result row.

Will throw NSException if the column name is unknown, or if the column value is NULL.

- (BOOL) isNullForColumnIndex:

(int)

columnIndex

Returns YES if the value of the given column index is NULL, NO otherwise.

Will throw NSException if the column index is out of range.

- (BOOL) isNullForColumn:

(NSString *)

columnName

Returns YES if the value of the named column is NULL, NO otherwise.

Will throw NSException if the column index is out of range.

- (BOOL) boolForColumn:

(NSString *)

columnName

Returns the BOOL value of the named column from the current result row.

Will throw NSException if the column name is unknown, or if the column value is NULL.

- (BOOL) boolForColumnIndex:

(int)

columnIndex

Returns the BOOL value of the given column index from the current result row.

Will throw NSException if the column index is out of range, or if the column value is NULL.

- (float) floatForColumn:

(NSString *)

columnName

Returns the float value of the named column from the current result row.

Will throw NSException if the column name is unknown, or if the column value is NULL.

- (float) floatForColumnIndex:

(int)

columnIndex

Returns the float value of the given column index from the current result row.

Will throw NSException if the column index is out of range, or if the column value is NULL.

- (double) doubleForColumn:

(NSString *)

columnName

Returns the double value of the named column from the current result row.

Will throw NSException if the column name is unknown, or if the column value is NULL.

- (double) doubleForColumnIndex:

(int)

columnIndex

Returns the double value of the given column index from the current result row.

Will throw NSException if the column index is out of range, or if the column value is NULL.

- (NSDate *) dateForColumn:

(NSString *)

columnName

Returns the NSDate value of the named column from the current result row.

Will throw NSException if the column name is unknown, or if the column value is NULL.

- (NSDate *) dateForColumnIndex:

(int)

columnIndex

Returns the NSDate value of the given column index from the current result row.

Will throw NSException if the column index is out of range, or if the column value is NULL.

- (NSData *) dataForColumn:

(NSString *)

columnName

Returns the NSData value of the named column from the current result row.

Will throw NSException if the column name is unknown, or if the column value is NULL.

- (NSData *) dataForColumnIndex:

(int)

columnIndex

Returns the NSData value of the given column index from the current result row.

Will throw NSException if the column index is out of range, or if the column value is NULL.

---

The documentation for this protocol was generated from the following file:

• Classes/PLResultSet.h