Home >	Contents >	Index >

Expanded TOC   |    Accordion TOC   |    Annotated TOC   |    Index

ICS.CatalogDef

Queries a table for its column definition and stores the results in a list.

Syntax

public IList 
CatalogDef(String from,
           String listname,
           StringBuffer errstr)

Parameters

from

The name of the table.

listname

List name to present to XML side for processing. The name can be null, in which case a unique name is generated.

errstr

For return values; may contain error information.

Description

The CatalogDef method queries a table for its column definition and stores the results in a list. The list contains a row for each column in the table. The KEY and FOREIGN values will be identical for each row in the resultset, since they are table-specific values, rather than column-specific values.

Returns

IList object containing the results. The column names of this IList are as follows:

KEY	Name of table's primary key (unknown if table is foreign).
FOREIGN	If table is foreign, value is true; otherwise, false.
COLNAME	Name of the column in the table.
COLTYPE	Valid values are: text, integer, double binary, date/time, upload, or unknown.
COLSIZE	Size of the column based on database information.

 

Errno

If IList is null, an errno will be set. Use GetErrno to find the error.

 

		Home >	Contents >	Index >
	FatWire JAVA Reference Copyright 2005 by FatWire Software All rights reserved.