File: prguid13.htm

package info (click to toggle)
solid-doc 2.2-1
links: PTS
area: non-free
in suites: potato, slink
size: 3,436 kB
ctags: 11,371
sloc: makefile: 58; sh: 2
file content (867 lines) | stat: -rw-r--r-- 24,239 bytes
parent folder | download | duplicates (2)
<HTML>
<HEAD>
<TITLE>prguide.htm</TITLE>
<LINK REL="ToC" HREF="httoc.htm">
<LINK REL="Index" HREF="htindex.htm">
<LINK REL="Next" HREF="prguid14.htm">
<LINK REL="Previous" HREF="prguid12.htm"></HEAD>
<BODY BGCOLOR="#FFFFFF">
<P ALIGN=CENTER>
<A HREF="prguid12.htm" TARGET="_self"><IMG SRC="graprev.gif" WIDTH = 32 HEIGHT = 32 BORDER = 0 ALT="Previous Page"></A>
<A HREF="httoc.htm" TARGET="_self"><IMG SRC="gratoc.gif" WIDTH = 32 HEIGHT = 32 BORDER = 0 ALT="TOC"></A>
<A HREF="htindex.htm" TARGET="_self"><IMG SRC="graindex.gif" WIDTH = 32 HEIGHT = 32 BORDER = 0 ALT="Index"></A>
<A HREF="prguid14.htm" TARGET="_self"><IMG SRC="granext.gif" WIDTH = 32 HEIGHT = 32 BORDER = 0 ALT="Next Page"></A>
<HR ALIGN=CENTER>
<P>
<UL>
<LI>
<A HREF="#E9E14" >Function Reference</A>
<UL>
<LI>
<A HREF="#E10E56" >Function Descriptions</A>
<LI>
<A HREF="#E10E57" >Arguments  </A>
<LI>
<A HREF="#E10E58" >SOLID SQL API Include Files</A>
<LI>
<A HREF="#E10E59" >ODBC Include Files</A>
<LI>
<A HREF="#E10E60" >Diagnostics</A>
<LI>
<A HREF="#E10E61" >Tables and Views</A>
<LI>
<A HREF="#E10E62" >Catalog Functions</A>
<LI>
<A HREF="#E10E63" >Search Pattern Arguments</A></UL></UL>
<HR ALIGN=CENTER>
<A NAME="E9E14"></A>
<H1>
<FONT FACE="Arial"><B>FUNCTION REFERENCE</B></FONT></H1>
<BR>
<A NAME="E10E56"></A>
<H2>
<FONT FACE="Arial"><B>Function Descriptions</B><A NAME="I2"></A></FONT></H2>
<BLOCKQUOTE>
<P>The following pages describe each function in alphabetic order. Each function is defined as a C programming language function. Descriptions include the following:<A NAME="I3"></A>
</BLOCKQUOTE>
<UL>
<BLOCKQUOTE>
<LI>Purpose<A NAME="I4"></A>
</BLOCKQUOTE>
<BLOCKQUOTE>
<LI>ODBC version<A NAME="I5"></A>
</BLOCKQUOTE>
<BLOCKQUOTE>
<LI>Conformance level<A NAME="I6"></A>
</BLOCKQUOTE>
<BLOCKQUOTE>
<LI>Syntax<A NAME="I7"></A>
</BLOCKQUOTE>
<BLOCKQUOTE>
<LI>Arguments<A NAME="I8"></A>
</BLOCKQUOTE>
<BLOCKQUOTE>
<LI>Return values<A NAME="I9"></A>
</BLOCKQUOTE>
<BLOCKQUOTE>
<LI>Diagnostics<A NAME="I10"></A>
</BLOCKQUOTE>
<BLOCKQUOTE>
<LI>Comments about usage and implementation<A NAME="I11"></A>
</BLOCKQUOTE>
<BLOCKQUOTE>
<LI>Code example<A NAME="I12"></A>
</BLOCKQUOTE>
<BLOCKQUOTE>
<LI>References to related functions<A NAME="I13"></A>
</BLOCKQUOTE></UL>
<BLOCKQUOTE>
<P>Error handling is described in the <B>SQLError</B> function description. The text associated with SQLSTATE values is included to provide a description of the condition, but is not intended to prescribe specific text.
</BLOCKQUOTE>
<A NAME="E10E57"></A>
<H2>
<FONT FACE="Arial"><B>Arguments</B><B> </B><B> </B><A NAME="I14"></A><A NAME="I15"></A></FONT></H2>
<BLOCKQUOTE>
<P>All function arguments use a naming convention of the following form:
</BLOCKQUOTE>
<BLOCKQUOTE>
<P>[[<I>prefix</I>]...]<I>tag</I>[<I>qualifier</I>][<I>suffix</I>]<A NAME="I16"></A>
</BLOCKQUOTE>
<BLOCKQUOTE>
<P>Optional elements are enclosed in square brackets ([]). The following prefixes are used:
</BLOCKQUOTE>
<TABLE WIDTH=800>
<TR>
<TD WIDTH=133 VALIGN=top >
<BLOCKQUOTE>
<P><B>Prefix</B>
</BLOCKQUOTE></TD>
<TD WIDTH=320 VALIGN=top >
<A NAME="E7E141"></A>
<P>Description</TD>
</TR>
<TR>
<TD WIDTH=133 VALIGN=top >
<BLOCKQUOTE>
<P>c<A NAME="I17"></A>
</BLOCKQUOTE></TD>
<TD WIDTH=320 VALIGN=top >
<A NAME="E7E142"></A>
<P>Count of</TD>
</TR>
<TR>
<TD WIDTH=133 VALIGN=top >
<BLOCKQUOTE>
<P>h
</BLOCKQUOTE></TD>
<TD WIDTH=320 VALIGN=top >
<A NAME="E7E143"></A>
<P>Handle of</TD>
</TR>
<TR>
<TD WIDTH=133 VALIGN=top >
<BLOCKQUOTE>
<P>I
</BLOCKQUOTE></TD>
<TD WIDTH=320 VALIGN=top >
<A NAME="E7E144"></A>
<P>Index of</TD>
</TR>
<TR>
<TD WIDTH=133 VALIGN=top >
<BLOCKQUOTE>
<P>p
</BLOCKQUOTE></TD>
<TD WIDTH=320 VALIGN=top >
<A NAME="E7E145"></A>
<P>Pointer to</TD>
</TR>
<TR>
<TD WIDTH=133 VALIGN=top >
<BLOCKQUOTE>
<P>rg
</BLOCKQUOTE></TD>
<TD WIDTH=320 VALIGN=top >
<A NAME="E7E146"></A>
<P>Range (array) of</TD></TR></TABLE>
<BLOCKQUOTE>
<P>The following tags are used:
</BLOCKQUOTE>
<TABLE WIDTH=800>
<TR>
<TD WIDTH=133 VALIGN=top >
<BLOCKQUOTE>
<P><B>Tag</B>
</BLOCKQUOTE></TD>
<TD WIDTH=320 VALIGN=top >
<A NAME="E7E147"></A>
<P>Description</TD>
</TR>
<TR>
<TD WIDTH=133 VALIGN=top >
<BLOCKQUOTE>
<P>b
</BLOCKQUOTE></TD>
<TD WIDTH=320 VALIGN=top >
<A NAME="E7E148"></A>
<P>Byte</TD>
</TR>
<TR>
<TD WIDTH=133 VALIGN=top >
<BLOCKQUOTE>
<P>col
</BLOCKQUOTE></TD>
<TD WIDTH=320 VALIGN=top >
<A NAME="E7E149"></A>
<P>Column (of a result set)</TD>
</TR>
<TR>
<TD WIDTH=133 VALIGN=top >
<BLOCKQUOTE>
<P>dbc
</BLOCKQUOTE></TD>
<TD WIDTH=320 VALIGN=top >
<A NAME="E7E150"></A>
<P>Database connection</TD>
</TR>
<TR>
<TD WIDTH=133 VALIGN=top >
<BLOCKQUOTE>
<P>env
</BLOCKQUOTE></TD>
<TD WIDTH=320 VALIGN=top >
<A NAME="E7E151"></A>
<P>Environment</TD>
</TR>
<TR>
<TD WIDTH=133 VALIGN=top >
<BLOCKQUOTE>
<P>f
</BLOCKQUOTE></TD>
<TD WIDTH=320 VALIGN=top >
<A NAME="E7E152"></A>
<P>Flag (enumerated type)</TD>
</TR>
<TR>
<TD WIDTH=133 VALIGN=top >
<BLOCKQUOTE>
<P>par
</BLOCKQUOTE></TD>
<TD WIDTH=320 VALIGN=top >
<A NAME="E7E153"></A>
<P>Parameter (of an SQL statement)</TD>
</TR>
<TR>
<TD WIDTH=133 VALIGN=top >
<BLOCKQUOTE>
<P>row
</BLOCKQUOTE></TD>
<TD WIDTH=320 VALIGN=top >
<A NAME="E7E154"></A>
<P>Row (of a result set)</TD>
</TR>
<TR>
<TD WIDTH=133 VALIGN=top >
<BLOCKQUOTE>
<P>stmt
</BLOCKQUOTE></TD>
<TD WIDTH=320 VALIGN=top >
<A NAME="E7E155"></A>
<P>Statement</TD>
</TR>
<TR>
<TD WIDTH=133 VALIGN=top >
<BLOCKQUOTE>
<P>sz
</BLOCKQUOTE></TD>
<TD WIDTH=320 VALIGN=top >
<A NAME="E7E156"></A>
<P>Character string (array of characters, terminated by zero)</TD>
</TR>
<TR>
<TD WIDTH=133 VALIGN=top >
<BLOCKQUOTE>
<P>v
</BLOCKQUOTE></TD>
<TD WIDTH=320 VALIGN=top >
<A NAME="E7E157"></A>
<P>Value of unspecified type</TD></TR></TABLE>
<BLOCKQUOTE>
<P>Prefixes and tags combine to correspond roughly to the ODBC C types listed below. Flags (f) and byte counts (cb) do not distinguish between SWORD, UWORD, SDWORD, and UDWORD.
</BLOCKQUOTE>
<TABLE WIDTH=800>
<TR>
<TD WIDTH=86 VALIGN=top >
<BLOCKQUOTE>
<P><B>Combined</B>
</BLOCKQUOTE></TD>
<TD WIDTH=66 VALIGN=top >
<A NAME="E7E158"></A>
<P>Prefix
</TD><TD WIDTH=60 VALIGN=top >
<A NAME="E7E158"></A>
<P>Tag
</TD><TD WIDTH=140 VALIGN=top >
<A NAME="E7E158"></A>
<P>ODBC C Type(s)
</TD><TD WIDTH=100 VALIGN=top >
<A NAME="E7E158"></A>
<P>Description</TD>
</TR>
<TR>
<TD WIDTH=86 VALIGN=top >
<BLOCKQUOTE>
<P>cb
</BLOCKQUOTE></TD>
<TD WIDTH=66 VALIGN=top >
<A NAME="E7E159"></A>
<P>c
</TD><TD WIDTH=60 VALIGN=top >
<A NAME="E7E159"></A>
<P>b
</TD><TD WIDTH=140 VALIGN=top >
<A NAME="E7E159"></A>
<P>SWORD, SDWORD, UDWORD
</TD><TD WIDTH=100 VALIGN=top >
<A NAME="E7E159"></A>
<P>Count of bytes</TD>
</TR>
<TR>
<TD WIDTH=86 VALIGN=top >
<BLOCKQUOTE>
<P>crow
</BLOCKQUOTE></TD>
<TD WIDTH=66 VALIGN=top >
<A NAME="E7E160"></A>
<P>c
</TD><TD WIDTH=60 VALIGN=top >
<A NAME="E7E160"></A>
<P>row
</TD><TD WIDTH=140 VALIGN=top >
<A NAME="E7E160"></A>
<P>SDWORD, UDWORD, UWORD
</TD><TD WIDTH=100 VALIGN=top >
<A NAME="E7E160"></A>
<P>Count of rows</TD>
</TR>
<TR>
<TD WIDTH=86 VALIGN=top >
<BLOCKQUOTE>
<P>f
</BLOCKQUOTE></TD>
<TD WIDTH=66 VALIGN=top >
<A NAME="E7E161"></A>
<P>&#150;
</TD><TD WIDTH=60 VALIGN=top >
<A NAME="E7E161"></A>
<P>f
</TD><TD WIDTH=140 VALIGN=top >
<A NAME="E7E161"></A>
<P>SWORD, UWORD
</TD><TD WIDTH=100 VALIGN=top >
<A NAME="E7E161"></A>
<P>Flag</TD>
</TR>
<TR>
<TD WIDTH=86 VALIGN=top >
<BLOCKQUOTE>
<P>hdbc
</BLOCKQUOTE></TD>
<TD WIDTH=66 VALIGN=top >
<A NAME="E7E162"></A>
<P>h
</TD><TD WIDTH=60 VALIGN=top >
<A NAME="E7E162"></A>
<P>dbc
</TD><TD WIDTH=140 VALIGN=top >
<A NAME="E7E162"></A>
<P>HDBC
</TD><TD WIDTH=100 VALIGN=top >
<A NAME="E7E162"></A>
<P>Connection handle</TD>
</TR>
<TR>
<TD WIDTH=86 VALIGN=top >
<BLOCKQUOTE>
<P>henv
</BLOCKQUOTE></TD>
<TD WIDTH=66 VALIGN=top >
<A NAME="E7E163"></A>
<P>h
</TD><TD WIDTH=60 VALIGN=top >
<A NAME="E7E163"></A>
<P>env
</TD><TD WIDTH=140 VALIGN=top >
<A NAME="E7E163"></A>
<P>HENV
</TD><TD WIDTH=100 VALIGN=top >
<A NAME="E7E163"></A>
<P>Environment handle</TD>
</TR>
<TR>
<TD WIDTH=86 VALIGN=top >
<BLOCKQUOTE>
<P>hstmt
</BLOCKQUOTE></TD>
<TD WIDTH=66 VALIGN=top >
<A NAME="E7E164"></A>
<P>h
</TD><TD WIDTH=60 VALIGN=top >
<A NAME="E7E164"></A>
<P>stmt
</TD><TD WIDTH=140 VALIGN=top >
<A NAME="E7E164"></A>
<P>HSTMT
</TD><TD WIDTH=100 VALIGN=top >
<A NAME="E7E164"></A>
<P>Statement handle</TD>
</TR>
<TR>
<TD WIDTH=86 VALIGN=top >
<BLOCKQUOTE>
<P>hwnd
</BLOCKQUOTE></TD>
<TD WIDTH=66 VALIGN=top >
<A NAME="E7E165"></A>
<P>h
</TD><TD WIDTH=60 VALIGN=top >
<A NAME="E7E165"></A>
<P>wnd
</TD><TD WIDTH=140 VALIGN=top >
<A NAME="E7E165"></A>
<P>HWND
</TD><TD WIDTH=100 VALIGN=top >
<A NAME="E7E165"></A>
<P>Window handle</TD>
</TR>
<TR>
<TD WIDTH=86 VALIGN=top >
<BLOCKQUOTE>
<P>ib
</BLOCKQUOTE></TD>
<TD WIDTH=66 VALIGN=top >
<A NAME="E7E166"></A>
<P>i
</TD><TD WIDTH=60 VALIGN=top >
<A NAME="E7E166"></A>
<P>b
</TD><TD WIDTH=140 VALIGN=top >
<A NAME="E7E166"></A>
<P>SWORD
</TD><TD WIDTH=100 VALIGN=top >
<A NAME="E7E166"></A>
<P>Byte index</TD></TR></TABLE>

<TABLE WIDTH=800>
<TR>
<TD WIDTH=86 VALIGN=top >
<BLOCKQUOTE>
<P>icol
</BLOCKQUOTE></TD>
<TD WIDTH=66 VALIGN=top >
<A NAME="E7E167"></A>
<P>i
</TD><TD WIDTH=60 VALIGN=top >
<A NAME="E7E167"></A>
<P>col
</TD><TD WIDTH=140 VALIGN=top >
<A NAME="E7E167"></A>
<P>UWORD
</TD><TD WIDTH=100 VALIGN=top >
<A NAME="E7E167"></A>
<P>Column index </TD>
</TR>
<TR>
<TD WIDTH=86 VALIGN=top >
<BLOCKQUOTE>
<P>ipar
</BLOCKQUOTE></TD>
<TD WIDTH=66 VALIGN=top >
<A NAME="E7E168"></A>
<P>i
</TD><TD WIDTH=60 VALIGN=top >
<A NAME="E7E168"></A>
<P>par
</TD><TD WIDTH=140 VALIGN=top >
<A NAME="E7E168"></A>
<P>UWORD
</TD><TD WIDTH=100 VALIGN=top >
<A NAME="E7E168"></A>
<P>Parameter index</TD>
</TR>
<TR>
<TD WIDTH=86 VALIGN=top >
<BLOCKQUOTE>
<P>irow
</BLOCKQUOTE></TD>
<TD WIDTH=66 VALIGN=top >
<A NAME="E7E169"></A>
<P>i
</TD><TD WIDTH=60 VALIGN=top >
<A NAME="E7E169"></A>
<P>row
</TD><TD WIDTH=140 VALIGN=top >
<A NAME="E7E169"></A>
<P>SDWORD, UWORD
</TD><TD WIDTH=100 VALIGN=top >
<A NAME="E7E169"></A>
<P>Row index</TD>
</TR>
<TR>
<TD WIDTH=86 VALIGN=top >
<BLOCKQUOTE>
<P>pcb
</BLOCKQUOTE></TD>
<TD WIDTH=66 VALIGN=top >
<A NAME="E7E170"></A>
<P>pc
</TD><TD WIDTH=60 VALIGN=top >
<A NAME="E7E170"></A>
<P>b
</TD><TD WIDTH=140 VALIGN=top >
<A NAME="E7E170"></A>
<P>SWORD FAR *, SDWORD FAR *, UDWORD FAR *
</TD><TD WIDTH=100 VALIGN=top >
<A NAME="E7E170"></A>
<P>Pointer to byte count</TD>
</TR>
<TR>
<TD WIDTH=86 VALIGN=top >
<BLOCKQUOTE>
<P>pccol
</BLOCKQUOTE></TD>
<TD WIDTH=66 VALIGN=top >
<A NAME="E7E171"></A>
<P>pc
</TD><TD WIDTH=60 VALIGN=top >
<A NAME="E7E171"></A>
<P>col
</TD><TD WIDTH=140 VALIGN=top >
<A NAME="E7E171"></A>
<P>SWORD FAR *
</TD><TD WIDTH=100 VALIGN=top >
<A NAME="E7E171"></A>
<P>Pointer to column count </TD>
</TR>
<TR>
<TD WIDTH=86 VALIGN=top >
<BLOCKQUOTE>
<P>pcpar
</BLOCKQUOTE></TD>
<TD WIDTH=66 VALIGN=top >
<A NAME="E7E172"></A>
<P>pc
</TD><TD WIDTH=60 VALIGN=top >
<A NAME="E7E172"></A>
<P>par
</TD><TD WIDTH=140 VALIGN=top >
<A NAME="E7E172"></A>
<P>SWORD FAR *
</TD><TD WIDTH=100 VALIGN=top >
<A NAME="E7E172"></A>
<P>Pointer to parameter count</TD>
</TR>
<TR>
<TD WIDTH=86 VALIGN=top >
<BLOCKQUOTE>
<P>pcrow
</BLOCKQUOTE></TD>
<TD WIDTH=66 VALIGN=top >
<A NAME="E7E173"></A>
<P>pc
</TD><TD WIDTH=60 VALIGN=top >
<A NAME="E7E173"></A>
<P>row
</TD><TD WIDTH=140 VALIGN=top >
<A NAME="E7E173"></A>
<P>SDWORD FAR *, UDWORD FAR *
</TD><TD WIDTH=100 VALIGN=top >
<A NAME="E7E173"></A>
<P>Pointer to row count</TD>
</TR>
<TR>
<TD WIDTH=86 VALIGN=top >
<BLOCKQUOTE>
<P>pf
</BLOCKQUOTE></TD>
<TD WIDTH=66 VALIGN=top >
<A NAME="E7E174"></A>
<P>p
</TD><TD WIDTH=60 VALIGN=top >
<A NAME="E7E174"></A>
<P>f
</TD><TD WIDTH=140 VALIGN=top >
<A NAME="E7E174"></A>
<P>SWORD, SDWORD, UWORD
</TD><TD WIDTH=100 VALIGN=top >
<A NAME="E7E174"></A>
<P>Pointer to flag</TD>
</TR>
<TR>
<TD WIDTH=86 VALIGN=top >
<BLOCKQUOTE>
<P>phdbc
</BLOCKQUOTE></TD>
<TD WIDTH=66 VALIGN=top >
<A NAME="E7E175"></A>
<P>ph
</TD><TD WIDTH=60 VALIGN=top >
<A NAME="E7E175"></A>
<P>dbc
</TD><TD WIDTH=140 VALIGN=top >
<A NAME="E7E175"></A>
<P>HDBC FAR *
</TD><TD WIDTH=100 VALIGN=top >
<A NAME="E7E175"></A>
<P>Pointer to connection handle</TD>
</TR>
<TR>
<TD WIDTH=86 VALIGN=top >
<BLOCKQUOTE>
<P>phenv
</BLOCKQUOTE></TD>
<TD WIDTH=66 VALIGN=top >
<A NAME="E7E176"></A>
<P>ph
</TD><TD WIDTH=60 VALIGN=top >
<A NAME="E7E176"></A>
<P>env
</TD><TD WIDTH=140 VALIGN=top >
<A NAME="E7E176"></A>
<P>HENV FAR *
</TD><TD WIDTH=100 VALIGN=top >
<A NAME="E7E176"></A>
<P>Pointer to environment handle</TD>
</TR>
<TR>
<TD WIDTH=86 VALIGN=top >
<BLOCKQUOTE>
<P>phstmt
</BLOCKQUOTE></TD>
<TD WIDTH=66 VALIGN=top >
<A NAME="E7E177"></A>
<P>ph
</TD><TD WIDTH=60 VALIGN=top >
<A NAME="E7E177"></A>
<P>stmt
</TD><TD WIDTH=140 VALIGN=top >
<A NAME="E7E177"></A>
<P>HSTMT FAR *
</TD><TD WIDTH=100 VALIGN=top >
<A NAME="E7E177"></A>
<P>Pointer to statement handle</TD>
</TR>
<TR>
<TD WIDTH=86 VALIGN=top >
<BLOCKQUOTE>
<P>pib
</BLOCKQUOTE></TD>
<TD WIDTH=66 VALIGN=top >
<A NAME="E7E178"></A>
<P>pi
</TD><TD WIDTH=60 VALIGN=top >
<A NAME="E7E178"></A>
<P>b
</TD><TD WIDTH=140 VALIGN=top >
<A NAME="E7E178"></A>
<P>SWORD FAR *
</TD><TD WIDTH=100 VALIGN=top >
<A NAME="E7E178"></A>
<P>Pointer to byte index</TD>
</TR>
<TR>
<TD WIDTH=86 VALIGN=top >
<BLOCKQUOTE>
<P>pirow
</BLOCKQUOTE></TD>
<TD WIDTH=66 VALIGN=top >
<A NAME="E7E179"></A>
<P>pi
</TD><TD WIDTH=60 VALIGN=top >
<A NAME="E7E179"></A>
<P>row
</TD><TD WIDTH=140 VALIGN=top >
<A NAME="E7E179"></A>
<P>UDWORD FAR *
</TD><TD WIDTH=100 VALIGN=top >
<A NAME="E7E179"></A>
<P>Pointer to row index</TD>
</TR>
<TR>
<TD WIDTH=86 VALIGN=top >
<BLOCKQUOTE>
<P>prgb
</BLOCKQUOTE></TD>
<TD WIDTH=66 VALIGN=top >
<A NAME="E7E180"></A>
<P>prg
</TD><TD WIDTH=60 VALIGN=top >
<A NAME="E7E180"></A>
<P>b
</TD><TD WIDTH=140 VALIGN=top >
<A NAME="E7E180"></A>
<P>PTR FAR *
</TD><TD WIDTH=100 VALIGN=top >
<A NAME="E7E180"></A>
<P>Pointer to range (array) of bytes</TD>
</TR>
<TR>
<TD WIDTH=86 VALIGN=top >
<BLOCKQUOTE>
<P>pv
</BLOCKQUOTE></TD>
<TD WIDTH=66 VALIGN=top >
<A NAME="E7E181"></A>
<P>p
</TD><TD WIDTH=60 VALIGN=top >
<A NAME="E7E181"></A>
<P>v
</TD><TD WIDTH=140 VALIGN=top >
<A NAME="E7E181"></A>
<P>PTR
</TD><TD WIDTH=100 VALIGN=top >
<A NAME="E7E181"></A>
<P>Pointer to value of unspecified type</TD>
</TR>
<TR>
<TD WIDTH=86 VALIGN=top >
<BLOCKQUOTE>
<P>rgb
</BLOCKQUOTE></TD>
<TD WIDTH=66 VALIGN=top >
<A NAME="E7E182"></A>
<P>rg
</TD><TD WIDTH=60 VALIGN=top >
<A NAME="E7E182"></A>
<P>b
</TD><TD WIDTH=140 VALIGN=top >
<A NAME="E7E182"></A>
<P>PTR
</TD><TD WIDTH=100 VALIGN=top >
<A NAME="E7E182"></A>
<P>Range (array) of bytes</TD>
</TR>
<TR>
<TD WIDTH=86 VALIGN=top >
<BLOCKQUOTE>
<P>rgf
</BLOCKQUOTE></TD>
<TD WIDTH=66 VALIGN=top >
<A NAME="E7E183"></A>
<P>rg
</TD><TD WIDTH=60 VALIGN=top >
<A NAME="E7E183"></A>
<P>f
</TD><TD WIDTH=140 VALIGN=top >
<A NAME="E7E183"></A>
<P>UWORD FAR *
</TD><TD WIDTH=100 VALIGN=top >
<A NAME="E7E183"></A>
<P>Range (array) of flags</TD>
</TR>
<TR>
<TD WIDTH=86 VALIGN=top >
<BLOCKQUOTE>
<P>sz
</BLOCKQUOTE></TD>
<TD WIDTH=66 VALIGN=top >
<A NAME="E7E184"></A>
<P>&#150;
</TD><TD WIDTH=60 VALIGN=top >
<A NAME="E7E184"></A>
<P>sz
</TD><TD WIDTH=140 VALIGN=top >
<A NAME="E7E184"></A>
<P>UCHAR FAR *
</TD><TD WIDTH=100 VALIGN=top >
<A NAME="E7E184"></A>
<P>String, zero terminated</TD>
</TR>
<TR>
<TD WIDTH=86 VALIGN=top >
<BLOCKQUOTE>
<P>v
</BLOCKQUOTE></TD>
<TD WIDTH=66 VALIGN=top >
<A NAME="E7E185"></A>
<P>&#150;
</TD><TD WIDTH=60 VALIGN=top >
<A NAME="E7E185"></A>
<P>v
</TD><TD WIDTH=140 VALIGN=top >
<A NAME="E7E185"></A>
<P>UDWORD
</TD><TD WIDTH=100 VALIGN=top >
<A NAME="E7E185"></A>
<P>Value of unspecified type</TD></TR></TABLE><BLOCKQUOTE>
<P>Qualifiers are used to distinguish specific variables of the same type. Qualifiers consist of the concatenation of one or more capitalized English words or abbreviations.<A NAME="I18"></A>
</BLOCKQUOTE>
<BLOCKQUOTE>
<P>ODBC defines one value for the suffix <I>Max</I>, which denotes that the variable represents the largest value of its type for a given situation.<A NAME="I19"></A>
</BLOCKQUOTE>
<BLOCKQUOTE>
<P>For example, the argument <I>cbErrorMsgMax</I> contains the largest possible byte count for an error message; in this case, the argument corresponds to the size in bytes of the argument <I>szErrorMsg</I>, a character string buffer. The argument <I>pcbErrorMsg</I> is a pointer to the count of bytes available to return in the argument <I>szErrorMsg</I>, not including the null termination character.
</BLOCKQUOTE>
<A NAME="E10E58"></A>
<H2>
<FONT FACE="Arial"><B>SOLID </B><B><I>SQL API</I></B><B> Include Files</B></FONT></H2>
<BLOCKQUOTE>
<P>The files CLI0CORE.H,  CLI0DEFS.H, CLI0ENV.H and CLI0EXT1.H contain function prototypes for all of the SOLID <I>SQL API</I> functions. They also contain all type definitions and <B>#define</B> names used by SOLID <I>SQL API</I>.
</BLOCKQUOTE>
<A NAME="E10E59"></A>
<H2>
<FONT FACE="Arial"><B>ODBC Include Files</B><A NAME="I20"></A><A NAME="I21"></A></FONT></H2>
<BLOCKQUOTE>
<P>The files SQL.H and SQLEXT.H contain function prototypes for all of the ODBC functions. They also contain all type definitions and <B>#define</B> names used by ODBC.
</BLOCKQUOTE>
<A NAME="E10E60"></A>
<H2>
<FONT FACE="Arial"><B>Diagnostics</B><A NAME="I22"></A><A NAME="I23"></A><A NAME="I24"></A></FONT></H2>
<BLOCKQUOTE>
<P>The diagnostics provided with each function list the SQLSTATEs that may be returned for the function by the Driver Manager or a driver. Drivers can, however, return additional SQLSTATEs arising out of implementation-specific situations.<A NAME="I25"></A>
</BLOCKQUOTE>
<BLOCKQUOTE>
<P>The character string value returned for an SQLSTATE consists of a two-character class value followed by a three-character subclass value. A class value of &quot;01&quot; indicates a warning and is accompanied by a return code of SQL_SUCCESS_WITH_INFO. Class values other than &quot;01&quot;, except for the class &quot;IM&quot;, indicate an error and are accompanied by a return code of SQL_ERROR. The class &quot;IM&quot; is specific to warnings and errors that derive from the implementation of ODBC itself. The subclass value &quot;000&quot; in any class is for implementation-defined conditions within the given class. The assignment of class and subclass values is defined by ANSI SQL-92.
</BLOCKQUOTE>
<A NAME="E10E61"></A>
<H2>
<FONT FACE="Arial"><B>Tables and Views</B><A NAME="I26"></A><A NAME="I27"></A><A NAME="I28"></A></FONT></H2>
<BLOCKQUOTE>
<P>In ODBC functions, tables and views are interchangeable. The term <I>table</I> is used for both tables and views, except where view is used explicitly.
</BLOCKQUOTE>
<A NAME="E10E62"></A>
<H2>
<FONT FACE="Arial"><B>Catalog Functions</B><A NAME="I29"></A></FONT></H2>
<BLOCKQUOTE>
<P>ODBC supports a set of functions that return information about the data source&#146;s system tables or catalog. These are sometimes referred to collectively as the <I>catalog functions</I>. For more information about catalog functions, see &quot;Retrieving Information About the Data Source&#146;s Catalog&quot; in Chapter 6.
</BLOCKQUOTE>
<BLOCKQUOTE>
<P>The catalog functions are:
</BLOCKQUOTE>
<BLOCKQUOTE>
<P><B>SQLColumnPrivileges</B>
</BLOCKQUOTE>
<BLOCKQUOTE>
<P><B>SQLColumns</B>
</BLOCKQUOTE>
<BLOCKQUOTE>
<P><B>SQLForeignKeys</B>
</BLOCKQUOTE>
<BLOCKQUOTE>
<P><B>SQLPrimaryKeys</B>
</BLOCKQUOTE>
<BLOCKQUOTE>
<P><B>SQLProcedureColumns</B>
</BLOCKQUOTE>
<BLOCKQUOTE>
<P><B>SQLProcedures</B>
</BLOCKQUOTE>
<BLOCKQUOTE>
<P><B>SQLSpecialColumns</B>
</BLOCKQUOTE>
<BLOCKQUOTE>
<P><B>SQLStatistics</B>
</BLOCKQUOTE>
<BLOCKQUOTE>
<P><B>SQLTablePrivileges</B>
</BLOCKQUOTE>
<BLOCKQUOTE>
<P><A NAME="I30"></A><B>SQLTables</B>
</BLOCKQUOTE>
<A NAME="E10E63"></A>
<H2>
<FONT FACE="Arial"><B>Search Pattern Arguments</B><A NAME="I31"></A><A NAME="I32"></A><A NAME="I33"></A><A NAME="I34"></A><A NAME="I35"></A><A NAME="I36"></A></FONT></H2>
<BLOCKQUOTE>
<P>Each catalog function returns information in the form of a result set. The information returned by a function may be constrained by a search pattern passed as an argument to that function. These search patterns can contain the metacharacters underscore (_) and percent (%) and a driver-defined escape character as follows:<A NAME="I37"></A><A NAME="I38"></A>
</BLOCKQUOTE>
<UL>
<BLOCKQUOTE>
<LI>The underscore character represents any single character.<A NAME="I39"></A><A NAME="I40"></A>
</BLOCKQUOTE>
<BLOCKQUOTE>
<LI>The percent character represents any sequence of zero or more characters.<A NAME="I41"></A><A NAME="I42"></A>
</BLOCKQUOTE>
<BLOCKQUOTE>
<LI>The escape character permits the underscore and percent metacharacters to be used as literal characters in search patterns. To use a metacharacter as a literal character in the search pattern, precede it with the escape character. To use the escape character as a literal character in the search pattern, include it twice. To obtain the escape character for a driver, an application must call <B>SQLGetInfo</B> with the SQL_SEARCH_PATTERN_ESCAPE option.<A NAME="I43"></A>
</BLOCKQUOTE>
<BLOCKQUOTE>
<LI>All other characters represent themselves.<A NAME="I44"></A>
</BLOCKQUOTE></UL>
<BLOCKQUOTE>
<P>For example, if the search pattern for a table name is &quot;%A%&quot;, the function will return all tables with names that contain the character &quot;A&quot;. If the search pattern for a table name is &quot;B__&quot; (&quot;B&quot; followed by two underscores), the function will return all tables with names that are three characters long and start with the character &quot;B&quot;. If the search pattern for a table name is &quot;%&quot;, the function will return all tables.<A NAME="I45"></A>
</BLOCKQUOTE>
<BLOCKQUOTE>
<P>Suppose the search pattern escape character for a driver is a backslash (\). If the search pattern for a table name is &quot;ABC\%&quot;, the function will return the table named &quot;ABC%.&quot; If the search pattern for a table name is &quot; \\%&quot;, the function will return all tables with names that start with a backslash. Failing to precede a metacharacter used as a literal with an escape character may return more results than expected. For example, if a table identifier, &quot;MY_TABLE&quot; was returned as the result of a call to <B>SQLTables</B> and an application wanted to retrieve a list of columns for &quot;MY_TABLE&quot; using <B>SQLColumns</B>, <B>SQLColumns</B> would return all of the tables that matched MY_TABLE, such as MY_TABLE, MY1TABLE, MY2TABLE, and so on, unless the escape character precedes the underscore.<A NAME="I46"></A>
</BLOCKQUOTE>
<BLOCKQUOTE>
<HR ALIGN=CENTER>
<NOTE>Note A zero-length search pattern matches the empty string. A search pattern argument that is a null pointer means the search will not be constrained for that argument. (A null pointer and a search string of &quot;%&quot; should return the same values.)</NOTE>
<HR ALIGN=CENTER>
</BLOCKQUOTE><P ALIGN=CENTER>
<A HREF="prguid12.htm" TARGET="_self"><IMG SRC="graprev.gif" WIDTH = 32 HEIGHT = 32 BORDER = 0 ALT="Previous Page"></A>
<A HREF="httoc.htm" TARGET="_self"><IMG SRC="gratoc.gif" WIDTH = 32 HEIGHT = 32 BORDER = 0 ALT="TOC"></A>
<A HREF="htindex.htm" TARGET="_self"><IMG SRC="graindex.gif" WIDTH = 32 HEIGHT = 32 BORDER = 0 ALT="Index"></A>
<A HREF="prguid14.htm" TARGET="_self"><IMG SRC="granext.gif" WIDTH = 32 HEIGHT = 32 BORDER = 0 ALT="Next Page"></A>

<center><p><font SIZE=-2>Copyright &copy; 1992-1997 Solid Information Technology Ltd All rights reserved.</font></p></center>
</BODY></HTML>