ch24_01.htm

by Randal L. Schwartz and Tom Phoenix ISBN 0-596-00132-0 Third Edition, published July 2001. (See

data sources and ODBC remarks about them. They are returned in the
form of:
</p><blockquote><pre class="code">$ArrayName{'DSN'}=Driver</pre></blockquote></div>

<a name="INDEX-3483" /><div class="refentry"><table width="515" border="0" cellpadding="5"><tr><td align="left"><font size="+1"><b>Debug</b></font></td><td align="right"><i></i></td></tr></table><hr width="515" size="3" noshade="true" align="left" color="black" /><pre>
Win32::ODBC-&gt;Debug( [ 0 | 1 ] )
</pre><p><a name="INDEX-3483" />Sets the debug option to on or
off. If nothing is specified, then nothing is changed. Returns the
debugging value (<tt class="literal">1</tt> or <tt class="literal">0</tt>).
</p></div>

<a name="INDEX-3484" /><div class="refentry"><table width="515" border="0" cellpadding="5"><tr><td align="left"><font size="+1"><b>Drivers</b></font></td><td align="right"><i></i></td></tr></table><hr width="515" size="3" noshade="true" align="left" color="black" /><pre>
Win32::ODBC-&gt;Drivers(  )
</pre><p><a name="INDEX-3484" />Returns an associative array of
ODBC Drivers and their attributes. They are returned in the form of:
</p><blockquote><pre class="code">$ArrayName{'<em class="replaceable"><tt>driver</em>'}=<em class="replaceable">Attrib1</em>;<em class="replaceable">Attrib2</em>;<em class="replaceable">Attrib3</em>;...</pre></blockquote><p>in which <em class="replaceable">driver</tt></em> is the ODBC driver name,
and <em class="replaceable"><tt>AttribX</tt></em> are the driver-defined
attributes.
</p></div>

<a name="INDEX-3485" /><div class="refentry"><table width="515" border="0" cellpadding="5"><tr><td align="left"><font size="+1"><b>DropCursor</b></font></td><td align="right"><i></i></td></tr></table><hr width="515" size="3" noshade="true" align="left" color="black" /><pre>
Win32::ODBC-&gt;DropCursor([<em class="replaceable">close_type</em>])
</pre><p><a name="INDEX-3485" />Drops the cursor associated with
the ODBC object. This forces the cursor to be deallocated. This
overrides <tt class="literal">SetStmtCloseType</tt>, but the ODBC object
does not lose the <tt class="literal">StmtCloseType</tt> setting.
<em class="replaceable"><tt>close_type</tt></em> can be any valid
<tt class="literal">SmtpCloseType</tt> and will perform a close on the
statement using the specified close type. Returns true on success,
false on failure.
</p></div>

<a name="INDEX-3486" /><div class="refentry"><table width="515" border="0" cellpadding="5"><tr><td align="left"><font size="+1"><b>DumpData</b></font></td><td align="right"><i></i></td></tr></table><hr width="515" size="3" noshade="true" align="left" color="black" /><pre>
Win32::ODBC-&gt;DumpData(  )
</pre><p><a name="INDEX-3486" />Dumps to the screen the
fieldnames and all records of the current data set. Used primarily
for debugging. No return value.
</p></div>

<a name="INDEX-3487" /><div class="refentry"><table width="515" border="0" cellpadding="5"><tr><td align="left"><font size="+1"><b>Error</b></font></td><td align="right"><i></i></td></tr></table><hr width="515" size="3" noshade="true" align="left" color="black" /><pre>
Win32::ODBC-&gt;Error(  )
</pre><p><a name="INDEX-3487" />Returns
the last encountered error. The returned value is context-dependent.
</p><p>If called in a scalar context, then a three-element array is
returned:
</p><blockquote><pre class="code">( <em class="replaceable"><tt>error_number</em>, <em class="replaceable">error_text</em>, <em class="replaceable">connection_number</em> )</pre></blockquote><p>If called in a string context, then a string is returned: </p><blockquote><pre class="code">"[<em class="replaceable">error_number</em>] [<em class="replaceable">connection_number</em>] [<em class="replaceable">error_text</em>]"</pre></blockquote><p>If debugging is on, then two more variables are returned: </p><blockquote><pre class="code">( ..., <em class="replaceable">function</em>, <em class="replaceable">level</em> )</pre></blockquote><p><em class="replaceable">function</tt></em> is the name of the function in
which the error occurred, and <em class="replaceable"><tt>level</tt></em>represents extra information about the error (usually the location of
the error).
</p></div>

<a name="INDEX-3488" /><div class="refentry"><table width="515" border="0" cellpadding="5"><tr><td align="left"><font size="+1"><b>FetchRow</b></font></td><td align="right"><i></i></td></tr></table><hr width="515" size="3" noshade="true" align="left" color="black" /><pre>
Win32::ODBC-&gt;FetchRow(<em class="replaceable">row</em>, [<em class="replaceable">type</em>])
</pre><p><a name="INDEX-3488" />Retrieves the next record from
the keyset. When <em class="replaceable"><tt>row</tt></em> and/or
<em class="replaceable"><tt>type</tt></em> are specified, the call is made using
SQLExtendedFetch instead of SQLFetch. Returns true when another
record is available to read and false when there are no more records.
</p></div>

<a name="INDEX-3489" /><div class="refentry"><table width="515" border="0" cellpadding="5"><tr><td align="left"><font size="+1"><b>FieldNames</b></font></td><td align="right"><i></i></td></tr></table><hr width="515" size="3" noshade="true" align="left" color="black" /><pre>
Win32::ODBC-&gt;FieldNames(  )
</pre><p><a name="INDEX-3489" />Returns an array of fieldnames
found in the current data set. The order isn't
specified.
</p></div>

<a name="INDEX-3490" /><div class="refentry"><table width="515" border="0" cellpadding="5"><tr><td align="left"><font size="+1"><b>GetConnections</b></font></td><td align="right"><i></i></td></tr></table><hr width="515" size="3" noshade="true" align="left" color="black" /><pre>
Win32::ODBC-&gt;GetConnections(  )
</pre><p><a name="INDEX-3490" />Returns an array of connection
numbers showing which connections are currently open.
</p></div>

<a name="INDEX-3491" /><div class="refentry"><table width="515" border="0" cellpadding="5"><tr><td align="left"><font size="+1"><b>GetConnectOption</b></font></td><td align="right"><i></i></td></tr></table><hr width="515" size="3" noshade="true" align="left" color="black" /><pre>
Win32::ODBC-&gt;GetConnectOption(<em class="replaceable">option</em>)
</pre><p><a name="INDEX-3491" />Returns the value of the
specified connect option <em class="replaceable"><tt>option</tt></em>. (Refer to
ODBC documentation for more information on the options and values.)
Returns a string or scalar depending upon the option specified.
</p></div>

<a name="INDEX-3492" /><div class="refentry"><table width="515" border="0" cellpadding="5"><tr><td align="left"><font size="+1"><b>GetCursorName</b></font></td><td align="right"><i></i></td></tr></table><hr width="515" size="3" noshade="true" align="left" color="black" /><pre>
Win32::ODBC-&gt;GetCursorName(  )
</pre><p><a name="INDEX-3492" />Returns the name of the current
cursor as a string or <tt class="literal">undef</tt>.
</p></div>

<a name="INDEX-3493" /><div class="refentry"><table width="515" border="0" cellpadding="5"><tr><td align="left"><font size="+1"><b>GetData</b></font></td><td align="right"><i></i></td></tr></table><hr width="515" size="3" noshade="true" align="left" color="black" /><pre>
Win32::ODBC-&gt;GetData(  )
</pre><p><a name="INDEX-3493" />Retrieves the current row from
the dataset. This is not generally used by users; it is used
internally. Returns an array of field data in which the first element
is either false (if successful) or true (if not successful).
</p></div>

<a name="INDEX-3494" /><div class="refentry"><table width="515" border="0" cellpadding="5"><tr><td align="left"><font size="+1"><b>getDSN</b></font></td><td align="right"><i></i></td></tr></table><hr width="515" size="3" noshade="true" align="left" color="black" /><pre>
Win32::ODBC-&gt;getDSN([<em class="replaceable">dsn</em>])
</pre><p><a name="INDEX-3494" />Returns an associative array
indicating the configuration for the specified
<em class="replaceable"><tt>dsn</em>. If no <em class="replaceable">dsn</tt></em>is specified, then the current connection is used. The returned
associative array consists of:
</p><blockquote><pre class="code">keys=DSN keyword; values=Keyword value. 
$Data{$Keyword}=Value</pre></blockquote></div>

<a name="INDEX-3495" /><div class="refentry"><table width="515" border="0" cellpadding="5"><tr><td align="left"><font size="+1"><b>GetFunctions</b></font></td><td align="right"><i></i></td></tr></table><hr width="515" size="3" noshade="true" align="left" color="black" /><pre>
Win32::ODBC-&gt;GetFunctions([<em class="replaceable">function1</em>, <em class="replaceable">function2</em>])
</pre><p><a name="INDEX-3495" />Returns an associative array
indicating the ability of the ODBC Driver to support the specified
functions. If no functions are specified, then a 100-element
associative array is returned containing all possible functions and
their values. <em class="replaceable"><tt>function</tt></em> must be in the form
of an ODBC API constant such as SQL_API_SQLTRANSACT. The returned
array will contain the results:
</p><blockquote><pre class="code">$Results{SQL_API_SQLTRANSACT}=Value</pre></blockquote><p>For example: </p><blockquote><pre class="code">$Results = $O-&gt;GetFunctions(
    $O-&gt;SQL_API_SQLTRANSACT,
    SQL_API_SQLSETCONNECTOPTION
);
$ConnectOption = $Results{SQL_API_SQLSETCONNECTOPTION};
$Transact = $Results{SQL_API_SQLTRANSACT};</pre></blockquote></div>

<a name="INDEX-3496" /><div class="refentry"><table width="515" border="0" cellpadding="5"><tr><td align="left"><font size="+1"><b>GetInfo</b></font></td><td align="right"><i></i></td></tr></table><hr width="515" size="3" noshade="true" align="left" color="black" /><pre>
Win32::ODBC-&gt;GetInfo([<em class="replaceable">option</em>])
</pre><p><a name="INDEX-3496" />Returns a string indicating the
value of the particular option specified.
</p></div>

<a name="INDEX-3497" /><div class="refentry"><table width="515" border="0" cellpadding="5"><tr><td align="left"><font size="+1"><b>GetMaxBufSize</b></font></td><td align="right"><i></i></td></tr></table><hr width="515" size="3" noshade="true" align="left" color="black" /><pre>
Win32::ODBC-&gt;GetMaxBufSize(  )
</pre><p><a name="INDEX-3497" />Returns the current allocated
limit for MaxBufSize. For more info, see SetMaxBufSize.
</p></div>

<a name="INDEX-3498" /><div class="refentry"><table width="515" border="0" cellpadding="5"><tr><td align="left"><font size="+1"><b>GetSQLState</b></font></td><td align="right"><i></i></td></tr></table><hr width="515" size="3" noshade="true" align="left" color="black" /><pre>
Win32::ODBC-&gt;GetSQLState(  )
</pre><p><a name="INDEX-3498" />Returns a string indicating the
SQL state as reported by ODBC. The SQL state is a code that the ODBC
Manager or ODBC Driver returns after the execution of a SQL function.
This is helpful for debugging purposes.
</p></div>

<a name="INDEX-3499" /><div class="refentry"><table width="515" border="0" cellpadding="5"><tr><td align="left"><font size="+1"><b>GetStmtCloseType</b></font></td><td align="right"><i></i></td></tr></table><hr width="515" size="3" noshade="true" align="left" color="black" /><pre>
Win32::ODBC-&gt;GetStmtCloseType([<em class="replaceable">connection</em>])
</pre><p><a name="INDEX-3499" />Returns a string indicating the
type of closure that will be used every time the hstmt is freed. (See
<tt class="literal">SetStmtCloseType</tt> for details.) By default, the
connection of the current object will be used. If