.TH GDI_PRINT_COLDEFS 3 "8/19/93 (v16.3)"
.ig
% ptroff -man gdi_print_coldefs.3
SccsID=@(#)gdi_print_coldefs.3	16.3 8/19/93
..
.SH NAME
.PP
gdi_print_coldefs \- output column definitions to stdout
.SH SYNOPSIS
.PP
.nf
.ta 8 16
.B #include "libgdi.h"
.sp
.B int
.B gdi_print_coldefs (obj)
\fBdbObj	*obj;\fP	/* (i) database data object */
.fi
.SH DESCRIPTION
.PP
gdi_print_coldefs() prints the column definitions of the database object,
\fIdbObj\fP, to \fIstdout\fP.  To print the \fIdbObj\fP use gdi_print_dbobj().  To
print the actual data use gdi_print_tuples().
.sp
Column attributes printed are:
.TP 12
.B Name
column name.
.TP 12
.B Null?
is a database Null allowed for this column? 1 if Null is permitted. 0 if not.
.TP 12
.B Ctype
integer values representing "C" language data types as defined in the include file libgdi.h,
for example: M_INTEGER, M_STRING.
.TP 12
.B StrSize
string length if column is a string type.
.TP 12
.B ArraySize
array length if column is an array type.
.TP 12
.B Prec
database precision value.
.TP 12
.B Scale
database scale value.
.TP 12
.B Dbtype
integer values representing database data types as defined in the
libgdi.h.  For ORACLE, the convention GDI_ORA_CHAR, GDI_ORA_NUMBER, etc. is
used.
.TP 12
.B DbtypeStr
human readable representation of the database type.
.br
.SH ARGUMENTS
.PP
.TP 12
.B obj
The database data object.
.SH DIAGNOSTICS
.PP
gdi_print_coldefs() returns one of the following status values.
.TP 12
.B GDI_SUCCESS
No problem outputting the column definitions.
.TP 12
.B GDI_FAILURE
NULL \fIdbObj\fP passed in.
.SH FILE
.PP
gdi_print.c
.SH SEE ALSO
.PP
.BR gdi_print_conn (3), 
.BR gdi_print_dbobj (3), 
.BR gdi_print_tuples (3)
.SH AUTHOR
.PP
Mari Mortell, SAIC Geophysical Systems Operation