vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/dws/dev/dws_04_0132.html
Lu, Huayi e6fa411af0 DWS DEV 830.201 version 
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com>
Co-authored-by: Lu, Huayi <luhuayi@huawei.com>
Co-committed-by: Lu, Huayi <luhuayi@huawei.com>
2024-05-16 07:24:04 +00:00

82 lines
9.8 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0000001188482260"></a><a name="EN-US_TOPIC_0000001188482260"></a>
<h1 class="topictitle1">SQLConnect</h1>
<div id="body8662426"><div class="section" id="EN-US_TOPIC_0000001188482260__se9be1d608bde4d27a7d9c64c60bcb6f2"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001188482260__a6a284ede34d64bb996429516d46e5b58"><strong id="EN-US_TOPIC_0000001188482260__b842352706103453">SQLConnect</strong> establishes a connection between a driver and a data source. After the connection, the connection handle can be used to access all information about the data source, including its application operating status, transaction processing status, and error information.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001188482260__s20f35442b8f44378a7fa2e7220fc0513"><h4 class="sectiontitle">Prototype</h4><div class="codecoloring" codetype="Cpp" id="EN-US_TOPIC_0000001188482260__s204d833a197846048f0c26a29849bef2"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
<span class="normal">2</span>
<span class="normal">3</span>
<span class="normal">4</span>
<span class="normal">5</span>
<span class="normal">6</span>
<span class="normal">7</span></pre></div></td><td class="code"><div><pre><span></span><span class="n">SQLRETURN</span><span class="w"> </span><span class="nf">SQLConnect</span><span class="p">(</span><span class="n">SQLHDBC</span><span class="w"> </span><span class="n">ConnectionHandle</span><span class="p">,</span>
<span class="w"> </span><span class="n">SQLCHAR</span><span class="w"> </span><span class="o">*</span><span class="n">ServerName</span><span class="p">,</span>
<span class="w"> </span><span class="n">SQLSMALLINT</span><span class="w"> </span><span class="n">NameLength1</span><span class="p">,</span>
<span class="w"> </span><span class="n">SQLCHAR</span><span class="w"> </span><span class="o">*</span><span class="n">UserName</span><span class="p">,</span>
<span class="w"> </span><span class="n">SQLSMALLINT</span><span class="w"> </span><span class="n">NameLength2</span><span class="p">,</span>
<span class="w"> </span><span class="n">SQLCHAR</span><span class="w"> </span><span class="o">*</span><span class="n">Authentication</span><span class="p">,</span>
<span class="w"> </span><span class="n">SQLSMALLINT</span><span class="w"> </span><span class="n">NameLength3</span><span class="p">);</span>
</pre></div></td></tr></table></div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001188482260__s3a97d1ad770a4a70b36964cda5365220"><h4 class="sectiontitle">Parameter</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001188482260__t2de7c9bf3fef43a195807fc5dda5b2bb" frame="border" border="1" rules="all"><caption><b>Table 1 </b>SQLConnect parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001188482260__r904210003ae94e13a8b583e891863802"><th align="left" class="cellrowborder" valign="top" width="24.04%" id="mcps1.3.3.2.2.3.1.1"><p id="EN-US_TOPIC_0000001188482260__ae9ed160b7664498ab9cfd8ce72ade4b0">Keyword</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="75.96000000000001%" id="mcps1.3.3.2.2.3.1.2"><p id="EN-US_TOPIC_0000001188482260__af40c221cf3804d1ea432591d21d87161">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001188482260__r475dbdfb542f457f8f8c938fb8c74a7e"><td class="cellrowborder" valign="top" width="24.04%" headers="mcps1.3.3.2.2.3.1.1 "><p id="EN-US_TOPIC_0000001188482260__ab18cdfef73e74a938f4df2f3a2b5a533">ConnectionHandle</p>
</td>
<td class="cellrowborder" valign="top" width="75.96000000000001%" headers="mcps1.3.3.2.2.3.1.2 "><p id="EN-US_TOPIC_0000001188482260__a426111d758a84cad9622112004199a4b">Connection handle, obtained from <strong id="EN-US_TOPIC_0000001188482260__b842352706105959">SQLAllocHandle</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001188482260__rcfce613456a941bd9be9b369a57e80c8"><td class="cellrowborder" valign="top" width="24.04%" headers="mcps1.3.3.2.2.3.1.1 "><p id="EN-US_TOPIC_0000001188482260__ac7071f274b5a4f7191705449911e5092">ServerName</p>
</td>
<td class="cellrowborder" valign="top" width="75.96000000000001%" headers="mcps1.3.3.2.2.3.1.2 "><p id="EN-US_TOPIC_0000001188482260__a93511f4627f04f67a852e73e6e3c1755">Name of the data source to connect to.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001188482260__ra0caf659d98549578f6eb5e392fe9d40"><td class="cellrowborder" valign="top" width="24.04%" headers="mcps1.3.3.2.2.3.1.1 "><p id="EN-US_TOPIC_0000001188482260__aa5869f9f566f47d3ab007ae3f8a4a130">NameLength1</p>
</td>
<td class="cellrowborder" valign="top" width="75.96000000000001%" headers="mcps1.3.3.2.2.3.1.2 "><p id="EN-US_TOPIC_0000001188482260__a2e5d5c6a195241c4b823ecb50e0025d6">Length of <strong id="EN-US_TOPIC_0000001188482260__b84235270611217">ServerName</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001188482260__r2b87e38acc4d48bc9608588765892aa5"><td class="cellrowborder" valign="top" width="24.04%" headers="mcps1.3.3.2.2.3.1.1 "><p id="EN-US_TOPIC_0000001188482260__ae3e17e3947134761ac58d4791f8086f0">UserName</p>
</td>
<td class="cellrowborder" valign="top" width="75.96000000000001%" headers="mcps1.3.3.2.2.3.1.2 "><p id="EN-US_TOPIC_0000001188482260__af15eedbe1e374b06bf63cfbb103c621a">User name of the database in the data source.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001188482260__rda7134b465a64e0e812ea4fed0f73cb8"><td class="cellrowborder" valign="top" width="24.04%" headers="mcps1.3.3.2.2.3.1.1 "><p id="EN-US_TOPIC_0000001188482260__aa0a3756bfadf4763af17d6189ec15e42">NameLength2</p>
</td>
<td class="cellrowborder" valign="top" width="75.96000000000001%" headers="mcps1.3.3.2.2.3.1.2 "><p id="EN-US_TOPIC_0000001188482260__affeebc5815b4475d9389ba53205ff14f">Length of <strong id="EN-US_TOPIC_0000001188482260__b84235270611227">UserName</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001188482260__r6df342a687a941a68c20b6eb4654e2bc"><td class="cellrowborder" valign="top" width="24.04%" headers="mcps1.3.3.2.2.3.1.1 "><p id="EN-US_TOPIC_0000001188482260__ad148cd63289b4c8f9d324f6c41406094">Authentication</p>
</td>
<td class="cellrowborder" valign="top" width="75.96000000000001%" headers="mcps1.3.3.2.2.3.1.2 "><p id="EN-US_TOPIC_0000001188482260__aed21314a5e7141f289ae354d482427b2">User password of the database in the data source.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001188482260__re982c1a01c3045f39c289261e03b02a6"><td class="cellrowborder" valign="top" width="24.04%" headers="mcps1.3.3.2.2.3.1.1 "><p id="EN-US_TOPIC_0000001188482260__aea6d22280cb14e568d3fe7b48204f863">NameLength3</p>
</td>
<td class="cellrowborder" valign="top" width="75.96000000000001%" headers="mcps1.3.3.2.2.3.1.2 "><p id="EN-US_TOPIC_0000001188482260__a169e44274cdf4f0b9c0636e035cda7af">Length of <strong id="EN-US_TOPIC_0000001188482260__b84235270611233">Authentication</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001188482260__s1545ba70250247afac010f16aad69e26"><h4 class="sectiontitle">Return Values</h4><ul id="EN-US_TOPIC_0000001188482260__u421b4d25b2fd434691089f0ad276c39a"><li id="EN-US_TOPIC_0000001188482260__l06842e280f0d448c81171500258eaf87"><strong id="EN-US_TOPIC_0000001188482260__b842352706112950">SQL_SUCCESS</strong> indicates that the call succeeded.</li><li id="EN-US_TOPIC_0000001188482260__l93a62674d8524e7ca29e53d1ec26c20f"><strong id="EN-US_TOPIC_0000001188482260__b842352706112952">SQL_SUCCESS_WITH_INFO</strong> indicates some warning information is displayed.</li><li id="EN-US_TOPIC_0000001188482260__lca39c145a7984f58955e8aa43d500cf6"><strong id="EN-US_TOPIC_0000001188482260__b842352706112954">SQL_ERROR</strong> indicates major errors, such as memory allocation and connection failures.</li><li id="EN-US_TOPIC_0000001188482260__ldae8a5c8c68c4983bba42e6332d477bc"><strong id="EN-US_TOPIC_0000001188482260__b842352706112956">SQL_INVALID_HANDLE</strong> indicates that invalid handles were called. Values returned by other APIs are similar to the preceding values.</li><li id="EN-US_TOPIC_0000001188482260__lbd9f7801ef034cea9e2f273779988613"><strong id="EN-US_TOPIC_0000001188482260__b842352706152119">SQL_STILL_EXECUTING</strong> indicates that the statement is being executed.</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001188482260__s78ccf9aa487a4e488f344ffcb13f97f6"><h4 class="sectiontitle">Precautions</h4><p id="EN-US_TOPIC_0000001188482260__a6e0a7ddf79ca4791980bcffd6e5914da">If <strong id="EN-US_TOPIC_0000001188482260__b13491434161416">SQLConnect</strong> returns <strong id="EN-US_TOPIC_0000001188482260__b17716764161422">SQL_ERROR</strong> or <strong id="EN-US_TOPIC_0000001188482260__b53360610161429">SQL_SUCCESS_WITH_INFO</strong>, the application can then call <a href="dws_04_0143.html">SQLGetDiagRec</a>, set <strong id="EN-US_TOPIC_0000001188482260__b28136448161439">HandleType</strong> and <strong id="EN-US_TOPIC_0000001188482260__b50806639161447">Handle</strong> to <strong id="EN-US_TOPIC_0000001188482260__b669744161451">SQL_HANDLE_DBC</strong> and <strong id="EN-US_TOPIC_0000001188482260__b33141305161458">ConnectionHandle</strong>, and obtain the <strong id="EN-US_TOPIC_0000001188482260__b935479016155">SQLSTATE</strong> value. The <strong id="EN-US_TOPIC_0000001188482260__b20652643161513">SQLSTATE</strong> value provides the detailed function calling information.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001188482260__scd1aba252b2d4400b164558aac8f8c81"><h4 class="sectiontitle">Examples</h4><p id="EN-US_TOPIC_0000001188482260__a4a2f61f6f31c44fda09a23e948d13dcf">See <a href="dws_04_0123.html">Examples</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dws_04_0124.html">ODBC Interfaces</a></div>
</div>
</div>
View Git Blame Copy Permalink