Home >	Contents >	Index >
Template Tag TOC  |   Alpha TOC  |   Tag Family TOC  |   Purpose TOC  |   Annotated TOC  |   Index

CATALOGDEF

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

Syntax

<CATALOGDEF LIST="LIST_NAME" 
            FROM="CATALOG_NAME"/>

Parameters

LIST (required)

List to contain column information for the table.

FROM (required)

Name of the table.

Description

The CATALOGDEF tag 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 are identical for each row in the resultset. The column names are as follows:

Column Name	Meaning
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	The values for COLTYPE can be: text, integer, double binary, date/time, upload, or unknown.
COLSIZE	Size of the column based on database information.

errno

The possible values of errno include:

Value	Description
-16	Empty List
-101	No rows found.
-102	Empty column.
-103	No such table.
-104	No table definition.

Example

This example displays the table definition of a table called Images:

<SETVAR NAME = "errno" VALUE = "0"/>
<CATALOGDEF LIST="table" FROM="movies"/>
 Key: <CSVAR NAME="table.KEY"/><br/>
 Foreign: <CSVAR NAME="table.FOREIGN"/><br/>
<RENAMELIST LIST="tbldef" FROM="table" />
<LOOP LIST="tbldef"> 
    Colname: <CSVAR NAME="tbldef.COLNAME"/>
   <br/>
   Coltype: <CSVAR NAME="tbldef.COLTYPE"/>
   <br/>
   Colsize: <CSVAR NAME="tbldef.COLSIZE"/>
   <br/>
</LOOP>
<IF COND="IsError.Variables.errno=true">
	 	 <THEN>
	 	 <!--Handle error-->
	 	 </THEN>
</IF>

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