D7net
Home
Console
Upload
information
Create File
Create Folder
About
Tools
:
/
opt
/
lampp
/
share
/
doc
/
freetds-0.91
/
reference
/
Filename :
a00092.html
back
Copy
<!-- This comment will put IE 6, 7 and 8 in quirks mode --> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <title>FreeTDS API: tds_column Struct Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javaScript" src="search/search.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body onload='searchBox.OnSelectItem(0);'> <!-- Generated by Doxygen 1.6.3 --> <script type="text/javascript"><!-- var searchBox = new SearchBox("searchBox", "search",false,'Search'); --></script> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> <li> <div id="MSearchBox" class="MSearchBoxInactive"> <img id="MSearchSelect" src="search/search.png" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" alt=""/> <input type="text" id="MSearchField" value="Search" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)"/> <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> </div> </li> </ul> </div> <div class="tabs"> <ul> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> </div> <div class="contents"> <h1>tds_column Struct Reference</h1><!-- doxytag: class="tds_column" --> <p>Metadata about columns in regular and compute rows. <a href="#_details">More...</a></p> <p><code>#include <<a class="el" href="a00159_source.html">tds.h</a>></code></p> <p><a href="a00400.html">List of all members.</a></p> <table border="0" cellpadding="0" cellspacing="0"> <tr><td colspan="2"><h2>Public Attributes</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a31708879692cd97cb3a72f8ca7940e00"></a><!-- doxytag: member="tds_column::bcp_column_data" ref="a31708879692cd97cb3a72f8ca7940e00" args="" --> <a class="el" href="a00089.html">BCPCOLDATA</a> * </td><td class="memItemRight" valign="bottom"><b>bcp_column_data</b></td></tr> <tr><td class="memItemLeft" align="right" valign="top">TDS_INT </td><td class="memItemRight" valign="bottom"><a class="el" href="a00092.html#a07d747c0592ff37eb467ba14c4dcaeb2">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="#a07d747c0592ff37eb467ba14c4dcaeb2"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a175979a3a8954bf66040c2b9e6a2ac17"></a><!-- doxytag: member="tds_column::bcp_term_len" ref="a175979a3a8954bf66040c2b9e6a2ac17" args="" --> TDS_INT </td><td class="memItemRight" valign="bottom"><b>bcp_term_len</b></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a095352960fe21d89d77c05b3a9f1f26d"></a><!-- doxytag: member="tds_column::bcp_terminator" ref="a095352960fe21d89d77c05b3a9f1f26d" args="" --> TDS_CHAR * </td><td class="memItemRight" valign="bottom"><b>bcp_terminator</b></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab3afb8272401bdb51064cdf910334159"></a><!-- doxytag: member="tds_column::char_conv" ref="ab3afb8272401bdb51064cdf910334159" args="" --> <a class="el" href="a00130.html">TDSICONV</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00092.html#ab3afb8272401bdb51064cdf910334159">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" align="right" valign="top"><a class="anchor" id="a9f60ba1cee60052957ebc8a87c611851"></a><!-- doxytag: member="tds_column::column_bindfmt" ref="a9f60ba1cee60052957ebc8a87c611851" args="" --> TDS_SMALLINT </td><td class="memItemRight" valign="bottom"><b>column_bindfmt</b></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4072589acad96c0cf2570c19deca4705"></a><!-- doxytag: member="tds_column::column_bindlen" ref="a4072589acad96c0cf2570c19deca4705" args="" --> TDS_UINT </td><td class="memItemRight" valign="bottom"><b>column_bindlen</b></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a642e30115c5bfc0828ff91f5f30f7eba"></a><!-- doxytag: member="tds_column::column_bindtype" ref="a642e30115c5bfc0828ff91f5f30f7eba" args="" --> TDS_SMALLINT </td><td class="memItemRight" valign="bottom"><b>column_bindtype</b></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3db89d652d698d148efe28794e2e527e"></a><!-- doxytag: member="tds_column::column_collation" ref="a3db89d652d698d148efe28794e2e527e" args="[5]" --> TDS_UCHAR </td><td class="memItemRight" valign="bottom"><b>column_collation</b> [5]</td></tr> <tr><td class="memItemLeft" align="right" valign="top">TDS_INT </td><td class="memItemRight" valign="bottom"><a class="el" href="a00092.html#ada14ba479a67762fc1bef78910ef4beb">column_cur_size</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">size written in variable (ie: char, text, binary). <a href="#ada14ba479a67762fc1bef78910ef4beb"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a76a3cc338a10f7b5469bed390cb0a917"></a><!-- doxytag: member="tds_column::column_data" ref="a76a3cc338a10f7b5469bed390cb0a917" args="" --> unsigned char * </td><td class="memItemRight" valign="bottom"><b>column_data</b></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a49eadba5cffaaaf3efc2cb475cd88539"></a><!-- doxytag: member="tds_column::column_data_free" ref="a49eadba5cffaaaf3efc2cb475cd88539" args=")(struct tds_column *column)" --> void(* </td><td class="memItemRight" valign="bottom"><b>column_data_free</b> )(struct <a class="el" href="a00092.html">tds_column</a> *column)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad73507c219fe639a1989007c2f0e0993"></a><!-- doxytag: member="tds_column::column_flags" ref="ad73507c219fe639a1989007c2f0e0993" args="" --> TDS_INT </td><td class="memItemRight" valign="bottom"><b>column_flags</b></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afc974e7f96be44e9b0042ef6c0479a5c"></a><!-- doxytag: member="tds_column::column_hidden" ref="afc974e7f96be44e9b0042ef6c0479a5c" args="" --> unsigned int </td><td class="memItemRight" valign="bottom"><b>column_hidden</b>:1</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a86d5a78cf688561a5d6e89d47029f86a"></a><!-- doxytag: member="tds_column::column_identity" ref="a86d5a78cf688561a5d6e89d47029f86a" args="" --> unsigned int </td><td class="memItemRight" valign="bottom"><b>column_identity</b>:1</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9ed7d796eca0a7606c6b914e8fa28360"></a><!-- doxytag: member="tds_column::column_key" ref="a9ed7d796eca0a7606c6b914e8fa28360" args="" --> unsigned int </td><td class="memItemRight" valign="bottom"><b>column_key</b>:1</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a54a425d9e17e260efc5e8bf7a7b96b36"></a><!-- doxytag: member="tds_column::column_lenbind" ref="a54a425d9e17e260efc5e8bf7a7b96b36" args="" --> TDS_INT * </td><td class="memItemRight" valign="bottom"><b>column_lenbind</b></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab32eb051ef27cb040a631de49b5c9921"></a><!-- doxytag: member="tds_column::column_name" ref="ab32eb051ef27cb040a631de49b5c9921" args="[TDS_SYSNAME_SIZE]" --> TDS_CHAR </td><td class="memItemRight" valign="bottom"><b>column_name</b> [TDS_SYSNAME_SIZE]</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acbc2ffb0cdbf78fa33b2307b6e250a88"></a><!-- doxytag: member="tds_column::column_namelen" ref="acbc2ffb0cdbf78fa33b2307b6e250a88" args="" --> TDS_SMALLINT </td><td class="memItemRight" valign="bottom"><a class="el" href="a00092.html#acbc2ffb0cdbf78fa33b2307b6e250a88">column_namelen</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">length of column name <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aae869137c65d87add8b1dcf7a387b2b9"></a><!-- doxytag: member="tds_column::column_nullable" ref="aae869137c65d87add8b1dcf7a387b2b9" args="" --> unsigned int </td><td class="memItemRight" valign="bottom"><b>column_nullable</b>:1</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1305fefbf84459f78d1d4223d134c875"></a><!-- doxytag: member="tds_column::column_nullbind" ref="a1305fefbf84459f78d1d4223d134c875" args="" --> TDS_SMALLINT * </td><td class="memItemRight" valign="bottom"><b>column_nullbind</b></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a314e3a06f9d9a39e264702d0d484bb58"></a><!-- doxytag: member="tds_column::column_operand" ref="a314e3a06f9d9a39e264702d0d484bb58" args="" --> TDS_SMALLINT </td><td class="memItemRight" valign="bottom"><b>column_operand</b></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a21170d5d0e0d24ea9e2cfa4ace1dcb26"></a><!-- doxytag: member="tds_column::column_operator" ref="a21170d5d0e0d24ea9e2cfa4ace1dcb26" args="" --> TDS_TINYINT </td><td class="memItemRight" valign="bottom"><b>column_operator</b></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abf4c4a1030ddca0e66cbded2802755bc"></a><!-- doxytag: member="tds_column::column_output" ref="abf4c4a1030ddca0e66cbded2802755bc" args="" --> unsigned int </td><td class="memItemRight" valign="bottom"><b>column_output</b>:1</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7ae346f8b1fdd364749825ca0863d166"></a><!-- doxytag: member="tds_column::column_prec" ref="a7ae346f8b1fdd364749825ca0863d166" args="" --> TDS_TINYINT </td><td class="memItemRight" valign="bottom"><a class="el" href="a00092.html#a7ae346f8b1fdd364749825ca0863d166">column_prec</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">precision for decimal/numeric <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab73b012b3a9f08da8661dc230ec17d7f"></a><!-- doxytag: member="tds_column::column_scale" ref="ab73b012b3a9f08da8661dc230ec17d7f" args="" --> TDS_TINYINT </td><td class="memItemRight" valign="bottom"><a class="el" href="a00092.html#ab73b012b3a9f08da8661dc230ec17d7f">column_scale</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">scale for decimal/numeric <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">TDS_INT </td><td class="memItemRight" valign="bottom"><a class="el" href="a00092.html#a2c2756c00a1099c82d4cfa4da2894672">column_size</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">maximun size of data. <a href="#a2c2756c00a1099c82d4cfa4da2894672"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af9bfdbfac29eb80d9a68fa07d0a9d850"></a><!-- doxytag: member="tds_column::column_text_sqlgetdatapos" ref="af9bfdbfac29eb80d9a68fa07d0a9d850" args="" --> TDS_INT </td><td class="memItemRight" valign="bottom"><b>column_text_sqlgetdatapos</b></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa35159e06d2dd719d3165eebf06a64b8"></a><!-- doxytag: member="tds_column::column_text_sqlputdatainfo" ref="aa35159e06d2dd719d3165eebf06a64b8" args="" --> TDS_CHAR </td><td class="memItemRight" valign="bottom"><b>column_text_sqlputdatainfo</b></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a28006c44692c543787ea6c47e8032f02"></a><!-- doxytag: member="tds_column::column_textpos" ref="a28006c44692c543787ea6c47e8032f02" args="" --> TDS_INT </td><td class="memItemRight" valign="bottom"><b>column_textpos</b></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3b2a509a0822c1869296ff673268913b"></a><!-- doxytag: member="tds_column::column_timestamp" ref="a3b2a509a0822c1869296ff673268913b" args="" --> unsigned int </td><td class="memItemRight" valign="bottom"><b>column_timestamp</b>:1</td></tr> <tr><td class="memItemLeft" align="right" valign="top">TDS_SMALLINT </td><td class="memItemRight" valign="bottom"><a class="el" href="a00092.html#af6d0def414a911f259e907860736b506">column_type</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">This type can be different from wire type because conversion (e.g. <a href="#af6d0def414a911f259e907860736b506"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae2fa3c291b6de01b3cd636f5f2c699ba"></a><!-- doxytag: member="tds_column::column_usertype" ref="ae2fa3c291b6de01b3cd636f5f2c699ba" args="" --> TDS_INT </td><td class="memItemRight" valign="bottom"><b>column_usertype</b></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab879ef62d9961283ec2d78332582a6e2"></a><!-- doxytag: member="tds_column::column_varaddr" ref="ab879ef62d9961283ec2d78332582a6e2" args="" --> TDS_CHAR * </td><td class="memItemRight" valign="bottom"><b>column_varaddr</b></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a12914f03ee2f24fa3fe577060410770d"></a><!-- doxytag: member="tds_column::column_varint_size" ref="a12914f03ee2f24fa3fe577060410770d" args="" --> TDS_TINYINT </td><td class="memItemRight" valign="bottom"><a class="el" href="a00092.html#a12914f03ee2f24fa3fe577060410770d">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" align="right" valign="top"><a class="anchor" id="a720d0627e9afa2e5cf991dbc330e5caa"></a><!-- doxytag: member="tds_column::column_writeable" ref="a720d0627e9afa2e5cf991dbc330e5caa" args="" --> unsigned int </td><td class="memItemRight" valign="bottom"><b>column_writeable</b>:1</td></tr> <tr><td class="memItemLeft" ><a class="anchor" id="a52b06379153103b49970980761915368"></a><!-- doxytag: member="tds_column::on_server" ref="a52b06379153103b49970980761915368" args="" --> struct {</td></tr> <tr><td class="memItemLeft" > TDS_INT <b>column_size</b></td></tr> <tr><td class="memItemLeft" > TDS_SMALLINT <a class="el" href="a00092.html#af6d0def414a911f259e907860736b506">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" valign="top">} </td><td class="memItemRight" valign="bottom"><b>on_server</b></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad8d49773fe767000571baf2d717c71e7"></a><!-- doxytag: member="tds_column::table_column_name" ref="ad8d49773fe767000571baf2d717c71e7" args="" --> char * </td><td class="memItemRight" valign="bottom"><b>table_column_name</b></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a634f3e3f08826eaf888161808c6b3e57"></a><!-- doxytag: member="tds_column::table_name" ref="a634f3e3f08826eaf888161808c6b3e57" args="[TDS_SYSNAME_SIZE]" --> TDS_CHAR </td><td class="memItemRight" valign="bottom"><b>table_name</b> [TDS_SYSNAME_SIZE]</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2536919b71fc1af3154aaf6f90aea53c"></a><!-- doxytag: member="tds_column::table_namelen" ref="a2536919b71fc1af3154aaf6f90aea53c" args="" --> TDS_SMALLINT </td><td class="memItemRight" valign="bottom"><b>table_namelen</b></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>Metadata about columns in regular and compute rows. </p> <hr/><h2>Member Data Documentation</h2> <a class="anchor" id="a07d747c0592ff37eb467ba14c4dcaeb2"></a><!-- doxytag: member="tds_column::bcp_prefix_len" ref="a07d747c0592ff37eb467ba14c4dcaeb2" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">TDS_INT <a class="el" href="a00092.html#a07d747c0592ff37eb467ba14c4dcaeb2">tds_column::bcp_prefix_len</a></td> </tr> </table> </div> <div class="memdoc"> <p>The length, in bytes, of any length prefix this column may have. </p> <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 do not have a length prefix, set prefixlen to 0. Currently not very used in code, however do not remove. </p> </div> </div> <a class="anchor" id="ada14ba479a67762fc1bef78910ef4beb"></a><!-- doxytag: member="tds_column::column_cur_size" ref="ada14ba479a67762fc1bef78910ef4beb" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">TDS_INT <a class="el" href="a00092.html#ada14ba479a67762fc1bef78910ef4beb">tds_column::column_cur_size</a></td> </tr> </table> </div> <div class="memdoc"> <p>size written in variable (ie: char, text, binary). </p> <p>-1 if NULL. </p> </div> </div> <a class="anchor" id="a2c2756c00a1099c82d4cfa4da2894672"></a><!-- doxytag: member="tds_column::column_size" ref="a2c2756c00a1099c82d4cfa4da2894672" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">TDS_INT <a class="el" href="a00092.html#a2c2756c00a1099c82d4cfa4da2894672">tds_column::column_size</a></td> </tr> </table> </div> <div class="memdoc"> <p>maximun size of data. </p> <p>For fixed is the size. </p> </div> </div> <a class="anchor" id="af6d0def414a911f259e907860736b506"></a><!-- doxytag: member="tds_column::column_type" ref="af6d0def414a911f259e907860736b506" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">TDS_SMALLINT <a class="el" href="a00092.html#af6d0def414a911f259e907860736b506">tds_column::column_type</a></td> </tr> </table> </div> <div class="memdoc"> <p>This type can be different from wire type because conversion (e.g. </p> <p>type of data, saved from wire</p> <p>UCS-2->Ascii) can be applied. I'm beginning to wonder about the wisdom of this, however. April 2003 jkl </p> </div> </div> <hr/>The documentation for this struct was generated from the following file:<ul> <li>/home/jklowden/releases/freetds-0.91/include/<a class="el" href="a00159_source.html">tds.h</a></li> </ul> </div> <!--- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Defines</a></div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <hr class="footer"/><address style="text-align: right;"><small>Generated on Wed Aug 17 22:22:35 2011 for FreeTDS API by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address> </body> </html>