📄 group__g__desc.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"><html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"><title>OCILIB (C Driver for Oracle): Describing Schema Metadata and Objects</title><link href="doxygen.css" rel="stylesheet" type="text/css"><link href="tabs.css" rel="stylesheet" type="text/css"></head><body><!-- Generated by Doxygen 1.5.4 --><div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="annotated.html"><span>Data Structures</span></a></li> <li><a href="files.html"><span>Files</span></a></li> </ul></div><h1>Describing Schema Metadata and Objects</h1><hr><a name="_details"></a><h2>Detailed Description</h2><dl class="user" compact><dt><b>Example</b></dt><dd><div class="fragment"><pre class="fragment"> <span class="preprocessor">#include "ocilib.h"</span><span class="keywordtype">int</span> main(<span class="keywordtype">void</span>){ <a class="code" href="struct_o_c_i___connection.html" title="Oracle physical connection.">OCI_Connection</a> *cn; OCI_Schema *tbl; <span class="keywordtype">int</span> i,n; <span class="keywordflow">if</span> (!<a class="code" href="group__g__init.html#gcdb642d75f7c8478e083634144bc813c" title="Initializes the library.">OCI_Initialize</a>(NULL, NULL, OCI_ENV_DEFAULT)) <span class="keywordflow">return</span> EXIT_FAILURE; cn = <a class="code" href="group__g__connect.html#gdb6e2cdf759587dd81c2fda7c5f44338" title="Create a physical connection to an Oracle database server.">OCI_ConnectionCreate</a>(<span class="stringliteral">"db"</span>, <span class="stringliteral">"usr"</span>, <span class="stringliteral">"pwd"</span>, OCI_SESSION_DEFAULT); tbl = OCI_SchemaGet(cn, <span class="stringliteral">"products"</span>, OCI_SCHEMA_TABLE); <span class="keywordflow">if</span> (tbl != NULL) { printf (<span class="stringliteral">"Column Name Type Length Prec. Scale Null ?\n"</span>); printf (<span class="stringliteral">"---------------------------- ------------------------------\n"</span>); n = OCI_SchemaGetColumnCount(tbl); <span class="keywordflow">for</span>(i = 1; i <= n; i++) { <a class="code" href="struct_o_c_i___column.html" title="Oracle SQL Column and Type member representation.">OCI_Column</a> *col = OCI_SchemaGetColumn(tbl, i); printf(<span class="stringliteral">"%-20s%-10s%-8i%-8i%-8i%-s\n"</span>, OCI_GetColumnName(col), OCI_GetColumnSQLType(col), OCI_GetColumnSize(col), OCI_GetColumnPrecision(col), OCI_GetColumnScale(col), OCI_GetColumnNullable(col) == TRUE ? <span class="stringliteral">"Y"</span> : <span class="stringliteral">"N"</span>); } } <a class="code" href="group__g__init.html#g639706aa8e9689c7ebffc018fac6d3ae" title="Clean up all resources allocated by the library.">OCI_Cleanup</a>(); <span class="keywordflow">return</span> EXIT_SUCCESS;}</pre></div> </dd></dl><p><table border="0" cellpadding="0" cellspacing="0"><tr><td></td></tr><tr><td colspan="2"><br><h2>Functions</h2></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">OCI_EXPORT <a class="el" href="struct_o_c_i___type_info.html">OCI_TypeInfo</a> *OCI_API </td><td class="memItemRight" valign="bottom"><a class="el" href="group__g__desc.html#g4990c22d2773746a0ab61ec95470445c">OCI_TypeInfoGet</a> (<a class="el" href="struct_o_c_i___connection.html">OCI_Connection</a> *con, const mtext *name, unsigned int type)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the available type info information. <a href="#g4990c22d2773746a0ab61ec95470445c"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">OCI_EXPORT unsigned int OCI_API </td><td class="memItemRight" valign="bottom"><a class="el" href="group__g__desc.html#gdd54c10b628fa994b367c29dd671fd1f">OCI_TypeInfoGetType</a> (<a class="el" href="struct_o_c_i___type_info.html">OCI_TypeInfo</a> *typinf)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Return the type of the type info object. <a href="#gdd54c10b628fa994b367c29dd671fd1f"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">OCI_EXPORT boolean OCI_API </td><td class="memItemRight" valign="bottom"><a class="el" href="group__g__desc.html#g5d8b11bf30702727e7c0499875ab9142">OCI_TypeInfoFree</a> (<a class="el" href="struct_o_c_i___type_info.html">OCI_TypeInfo</a> *typinf)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Free a type info object. <a href="#g5d8b11bf30702727e7c0499875ab9142"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">OCI_EXPORT unsigned int OCI_API </td><td class="memItemRight" valign="bottom"><a class="el" href="group__g__desc.html#g9c93a72421d19de30acbf05a53353c93">OCI_TypeInfoGetColumnCount</a> (<a class="el" href="struct_o_c_i___type_info.html">OCI_TypeInfo</a> *typinf)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Retruns the number of columns of a table/view/object. <a href="#g9c93a72421d19de30acbf05a53353c93"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">OCI_EXPORT <a class="el" href="struct_o_c_i___column.html">OCI_Column</a> *OCI_API </td><td class="memItemRight" valign="bottom"><a class="el" href="group__g__desc.html#gb22a6fcb3d64c74adfc7506f1ce343d7">OCI_TypeInfoGetColumn</a> (<a class="el" href="struct_o_c_i___type_info.html">OCI_TypeInfo</a> *typinf, unsigned int index)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Return the column object handle at the given index in the table. <a href="#gb22a6fcb3d64c74adfc7506f1ce343d7"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">OCI_EXPORT const mtext *OCI_API </td><td class="memItemRight" valign="bottom"><a class="el" href="group__g__desc.html#gdd7ec9a89e3ceb50691c6ae68a80e030">OCI_TypeInfoGetName</a> (<a class="el" href="struct_o_c_i___type_info.html">OCI_TypeInfo</a> *typinf)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Return the name described by the type info object. <a href="#gdd7ec9a89e3ceb50691c6ae68a80e030"></a><br></td></tr></table><hr><h2>Function Documentation</h2><a class="anchor" name="g5d8b11bf30702727e7c0499875ab9142"></a><!-- doxytag: member="ocilib.h::OCI_TypeInfoFree" ref="g5d8b11bf30702727e7c0499875ab9142" args="(OCI_TypeInfo *typinf)" --><div class="memitem"><div class="memproto"> <table class="memname"> <tr> <td class="memname">OCI_EXPORT boolean OCI_API OCI_TypeInfoFree </td> <td>(</td> <td class="paramtype"><a class="el" href="struct_o_c_i___type_info.html">OCI_TypeInfo</a> * </td> <td class="paramname"> <em>typinf</em> </td> <td> ) </td> <td width="100%"></td> </tr> </table></div><div class="memdoc"><p>Free a type info object. <p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>typinf</em> </td><td>- Type info handle</td></tr> </table></dl><dl class="return" compact><dt><b>Returns:</b></dt><dd>TRUE on success otherwise FALSE </dd></dl></div></div><p><a class="anchor" name="g4990c22d2773746a0ab61ec95470445c"></a><!-- doxytag: member="ocilib.h::OCI_TypeInfoGet" ref="g4990c22d2773746a0ab61ec95470445c" args="(OCI_Connection *con, const mtext *name, unsigned int type)" --><div class="memitem"><div class="memproto"> <table class="memname"> <tr> <td class="memname">OCI_EXPORT <a class="el" href="struct_o_c_i___type_info.html">OCI_TypeInfo</a>* OCI_API OCI_TypeInfoGet </td> <td>(</td> <td class="paramtype"><a class="el" href="struct_o_c_i___connection.html">OCI_Connection</a> * </td> <td class="paramname"> <em>con</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const mtext * </td> <td class="paramname"> <em>name</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">unsigned int </td> <td class="paramname"> <em>type</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"></td> </tr> </table></div><div class="memdoc"><p>Retrieve the available type info information. <p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>con</em> </td><td>- Connection handle </td></tr> <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>- Table/view name to query for </td></tr> <tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>- Type of object</td></tr> </table></dl><dl class="note" compact><dt><b>Note:</b></dt><dd>Possible values for parameter type are :</dd></dl><ul><li>OCI_UNKNOWN</li><li>OCI_TIF_TABLE</li><li>OCI_TIF_VIEW</li><li>OCI_TIF_TYPE</li></ul><p><dl class="return" compact><dt><b>Returns:</b></dt><dd><ul><li>Type info handle on success = - NULL if the object does not exist</li><li>NULL on failure </li></ul></dd></dl></div></div><p><a class="anchor" name="gb22a6fcb3d64c74adfc7506f1ce343d7"></a><!-- doxytag: member="ocilib.h::OCI_TypeInfoGetColumn" ref="gb22a6fcb3d64c74adfc7506f1ce343d7" args="(OCI_TypeInfo *typinf, unsigned int index)" --><div class="memitem"><div class="memproto"> <table class="memname"> <tr> <td class="memname">OCI_EXPORT <a class="el" href="struct_o_c_i___column.html">OCI_Column</a>* OCI_API OCI_TypeInfoGetColumn </td> <td>(</td> <td class="paramtype"><a class="el" href="struct_o_c_i___type_info.html">OCI_TypeInfo</a> * </td> <td class="paramname"> <em>typinf</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">unsigned int </td> <td class="paramname"> <em>index</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"></td> </tr> </table></div><div class="memdoc"><p>Return the column object handle at the given index in the table. <p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>typinf</em> </td><td>- Type info handle </td></tr> <tr><td valign="top"></td><td valign="top"><em>index</em> </td><td>- Column position</td></tr> </table></dl><dl class="return" compact><dt><b>Returns:</b></dt><dd><ul><li>Column handle on success</li><li>NULL if index is out of bounds or on error </li></ul></dd></dl></div></div><p><a class="anchor" name="g9c93a72421d19de30acbf05a53353c93"></a><!-- doxytag: member="ocilib.h::OCI_TypeInfoGetColumnCount" ref="g9c93a72421d19de30acbf05a53353c93" args="(OCI_TypeInfo *typinf)" --><div class="memitem"><div class="memproto"> <table class="memname"> <tr> <td class="memname">OCI_EXPORT unsigned int OCI_API OCI_TypeInfoGetColumnCount </td> <td>(</td> <td class="paramtype"><a class="el" href="struct_o_c_i___type_info.html">OCI_TypeInfo</a> * </td> <td class="paramname"> <em>typinf</em> </td> <td> ) </td> <td width="100%"></td> </tr> </table></div><div class="memdoc"><p>Retruns the number of columns of a table/view/object. <p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>typinf</em> </td><td>- Type info handle </td></tr> </table></dl></div></div><p><a class="anchor" name="gdd7ec9a89e3ceb50691c6ae68a80e030"></a><!-- doxytag: member="ocilib.h::OCI_TypeInfoGetName" ref="gdd7ec9a89e3ceb50691c6ae68a80e030" args="(OCI_TypeInfo *typinf)" --><div class="memitem"><div class="memproto"> <table class="memname"> <tr> <td class="memname">OCI_EXPORT const mtext* OCI_API OCI_TypeInfoGetName </td> <td>(</td> <td class="paramtype"><a class="el" href="struct_o_c_i___type_info.html">OCI_TypeInfo</a> * </td> <td class="paramname"> <em>typinf</em> </td> <td> ) </td> <td width="100%"></td> </tr> </table></div><div class="memdoc"><p>Return the name described by the type info object. <p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>typinf</em> </td><td>- Type info handle</td></tr> </table></dl><dl class="return" compact><dt><b>Returns:</b></dt><dd></dd></dl></div></div><p><a class="anchor" name="gdd54c10b628fa994b367c29dd671fd1f"></a><!-- doxytag: member="ocilib.h::OCI_TypeInfoGetType" ref="gdd54c10b628fa994b367c29dd671fd1f" args="(OCI_TypeInfo *typinf)" --><div class="memitem"><div class="memproto"> <table class="memname"> <tr> <td class="memname">OCI_EXPORT unsigned int OCI_API OCI_TypeInfoGetType </td> <td>(</td> <td class="paramtype"><a class="el" href="struct_o_c_i___type_info.html">OCI_TypeInfo</a> * </td> <td class="paramname"> <em>typinf</em> </td> <td> ) </td> <td width="100%"></td> </tr> </table></div><div class="memdoc"><p>Return the type of the type info object. <p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>typinf</em> </td><td>- Type info handle</td></tr> </table></dl><dl class="note" compact><dt><b>Note:</b></dt><dd>Possible values for parameter type are :</dd></dl><ul><li>OCI_UNKNOWM</li><li>OCI_TIF_TABLE</li><li>OCI_TIF_VIEW</li><li>OCI_TIF_TYPE</li></ul><p><dl class="return" compact><dt><b>Returns:</b></dt><dd>Object type or OCI_UNKNOWN the input handle is NULL </dd></dl></div></div><p><hr size="1"><address style="text-align: right;"><small>Generated on Sat Apr 18 01:13:15 2009 for OCILIB (C Driver for Oracle) by <a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.4 </small></address></body></html>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -