<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>FreeTDS API: tds_column Struct Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.1 -->
<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="globals.html">File Members</a> | <a class="qindex" href="pages.html">Related Pages</a></div>
<h1>tds_column Struct Reference</h1>Metadata about columns in regular and compute rows.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="a00311.html">tds.h</a>></code>
<p>
<a href="a00100.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o0" doxytag="tds_column::bcp_column_data"></a>
BCPCOLDATA * </td><td class="memItemRight" valign="bottom"><b>bcp_column_data</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">TDS_INT </td><td class="memItemRight" valign="bottom"><a class="el" href="a00140.html#o1">bcp_prefix_len</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The length, in bytes, of any length prefix this column may have. <a href="#o1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o2" doxytag="tds_column::bcp_term_len"></a>
TDS_INT </td><td class="memItemRight" valign="bottom"><b>bcp_term_len</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o3" doxytag="tds_column::bcp_terminator"></a>
TDS_CHAR * </td><td class="memItemRight" valign="bottom"><b>bcp_terminator</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o4" doxytag="tds_column::char_conv"></a>
const TDSICONV * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00140.html#o4">char_conv</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">refers to previously allocated iconv information <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o5" doxytag="tds_column::column_bindfmt"></a>
TDS_SMALLINT </td><td class="memItemRight" valign="bottom"><b>column_bindfmt</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o6" doxytag="tds_column::column_bindlen"></a>
TDS_UINT </td><td class="memItemRight" valign="bottom"><b>column_bindlen</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o7" doxytag="tds_column::column_bindtype"></a>
TDS_SMALLINT </td><td class="memItemRight" valign="bottom"><b>column_bindtype</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o8" doxytag="tds_column::column_collation"></a>
TDS_UCHAR </td><td class="memItemRight" valign="bottom"><b>column_collation</b> [5]</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">TDS_INT </td><td class="memItemRight" valign="bottom"><a class="el" href="a00140.html#o9">column_cur_size</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">size written in variable (ie: char, text, binary). <a href="#o9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o10" doxytag="tds_column::column_data"></a>
unsigned char * </td><td class="memItemRight" valign="bottom"><b>column_data</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o11" doxytag="tds_column::column_data_free"></a>
void(* </td><td class="memItemRight" valign="bottom"><b>column_data_free</b> )(struct <a class="el" href="a00140.html">tds_column</a> *column)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o12" doxytag="tds_column::column_flags"></a>
TDS_INT </td><td class="memItemRight" valign="bottom"><b>column_flags</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o13" doxytag="tds_column::column_hidden"></a>
unsigned int </td><td class="memItemRight" valign="bottom"><b>column_hidden</b>:1</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o14" doxytag="tds_column::column_identity"></a>
unsigned int </td><td class="memItemRight" valign="bottom"><b>column_identity</b>:1</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o15" doxytag="tds_column::column_key"></a>
unsigned int </td><td class="memItemRight" valign="bottom"><b>column_key</b>:1</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o16" doxytag="tds_column::column_lenbind"></a>
TDS_INT * </td><td class="memItemRight" valign="bottom"><b>column_lenbind</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o17" doxytag="tds_column::column_name"></a>
TDS_CHAR </td><td class="memItemRight" valign="bottom"><b>column_name</b> [TDS_SYSNAME_SIZE]</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o18" doxytag="tds_column::column_namelen"></a>
TDS_SMALLINT </td><td class="memItemRight" valign="bottom"><a class="el" href="a00140.html#o18">column_namelen</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">length of column name <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o19" doxytag="tds_column::column_nullable"></a>
unsigned int </td><td class="memItemRight" valign="bottom"><b>column_nullable</b>:1</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o20" doxytag="tds_column::column_nullbind"></a>
TDS_SMALLINT * </td><td class="memItemRight" valign="bottom"><b>column_nullbind</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o21" doxytag="tds_column::column_operand"></a>
TDS_SMALLINT </td><td class="memItemRight" valign="bottom"><b>column_operand</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o22" doxytag="tds_column::column_operator"></a>
TDS_TINYINT </td><td class="memItemRight" valign="bottom"><b>column_operator</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o23" doxytag="tds_column::column_output"></a>
unsigned int </td><td class="memItemRight" valign="bottom"><b>column_output</b>:1</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o24" doxytag="tds_column::column_prec"></a>
TDS_TINYINT </td><td class="memItemRight" valign="bottom"><a class="el" href="a00140.html#o24">column_prec</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">precision for decimal/numeric <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o25" doxytag="tds_column::column_scale"></a>
TDS_TINYINT </td><td class="memItemRight" valign="bottom"><a class="el" href="a00140.html#o25">column_scale</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">scale for decimal/numeric <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">TDS_INT </td><td class="memItemRight" valign="bottom"><a class="el" href="a00140.html#o26">column_size</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">maximun size of data <a href="#o26"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o27" doxytag="tds_column::column_text_sqlgetdatapos"></a>
TDS_INT </td><td class="memItemRight" valign="bottom"><b>column_text_sqlgetdatapos</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o28" doxytag="tds_column::column_textpos"></a>
TDS_INT </td><td class="memItemRight" valign="bottom"><b>column_textpos</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o29" doxytag="tds_column::column_timestamp"></a>
unsigned int </td><td class="memItemRight" valign="bottom"><b>column_timestamp</b>:1</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">TDS_SMALLINT </td><td class="memItemRight" valign="bottom"><a class="el" href="a00140.html#o30">column_type</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">type of data, saved from wire <a href="#o30"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o31" doxytag="tds_column::column_usertype"></a>
TDS_INT </td><td class="memItemRight" valign="bottom"><b>column_usertype</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o32" doxytag="tds_column::column_varaddr"></a>
TDS_CHAR * </td><td class="memItemRight" valign="bottom"><b>column_varaddr</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o33" doxytag="tds_column::column_varint_size"></a>
TDS_TINYINT </td><td class="memItemRight" valign="bottom"><a class="el" href="a00140.html#o33">column_varint_size</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">size of length when reading from wire (0, 1, 2 or 4) <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o34" doxytag="tds_column::column_writeable"></a>
unsigned int </td><td class="memItemRight" valign="bottom"><b>column_writeable</b>:1</td></tr>
<tr><td class="memItemLeft" nowrap><a class="anchor" name="o35" doxytag="tds_column::on_server"></a>
struct {</td></tr>
<tr><td class="memItemLeft" nowrap> TDS_INT <b>column_size</b></td></tr>
<tr><td class="memItemLeft" nowrap> TDS_SMALLINT <a class="el" href="a00140.html#o30">column_type</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">type of data, saved from wire <br></td></tr>
<tr><td class="memItemLeft" nowrap valign="top">} </td><td class="memItemRight" valign="bottom"><b>on_server</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o36" doxytag="tds_column::table_column_name"></a>
char * </td><td class="memItemRight" valign="bottom"><b>table_column_name</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o37" doxytag="tds_column::table_name"></a>
TDS_CHAR </td><td class="memItemRight" valign="bottom"><b>table_name</b> [TDS_SYSNAME_SIZE]</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o38" doxytag="tds_column::table_namelen"></a>
TDS_SMALLINT </td><td class="memItemRight" valign="bottom"><b>table_namelen</b></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Metadata about columns in regular and compute rows.
<p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="o1" doxytag="tds_column::bcp_prefix_len"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">TDS_INT <a class="el" href="a00140.html#o1">tds_column::bcp_prefix_len</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
The length, in bytes, of any length prefix this column may have.
<p>
For example, strings in some non-C programming languages are made up of a one-byte length prefix, followed by the string data itself. If the data does not have a length prefix, set prefixlen to 0. Currently not very used in code, however do not remove. </td>
</tr>
</table>
<a class="anchor" name="o9" doxytag="tds_column::column_cur_size"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">TDS_INT <a class="el" href="a00140.html#o9">tds_column::column_cur_size</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
size written in variable (ie: char, text, binary).
<p>
-1 if NULL. </td>
</tr>
</table>
<a class="anchor" name="o26" doxytag="tds_column::column_size"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">TDS_INT <a class="el" href="a00140.html#o26">tds_column::column_size</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
maximun size of data
<p>
For fixed is the size. </td>
</tr>
</table>
<a class="anchor" name="o30" doxytag="tds_column::column_type"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">TDS_SMALLINT <a class="el" href="a00140.html#o30">tds_column::column_type</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
type of data, saved from wire
<p>
UCS-2->Ascii) can be applied. I'm beginning to wonder about the wisdom of this, however. April 2003 jkl </td>
</tr>
</table>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>/usr/local/users/home/jklowden/projects/releases/freetds/0.82/include/<a class="el" href="a00311.html">tds.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Wed May 7 19:22:10 2008 for FreeTDS API by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.1 </small></address>
</body>
</html>
