File: function.odbc-setoption.html

package info (click to toggle)
php3 3%3A3.0.18-0potato1.1
links: PTS
area: main
in suites: potato
size: 17,736 kB
ctags: 11,198
sloc: ansic: 108,120; sh: 2,512; php: 2,024; yacc: 1,887; makefile: 1,038; perl: 537; pascal: 238; awk: 90; cpp: 28; sql: 11
file content (281 lines) | stat: -rw-r--r-- 4,763 bytes
parent folder | download | duplicates (3)
<HTML
><HEAD
><TITLE
>odbc_setoption</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.57"><LINK
REL="HOME"
TITLE="PHP Manual"
HREF="manual.html"><LINK
REL="UP"
TITLE="Unified ODBC functions"
HREF="ref.odbc.html"><LINK
REL="PREVIOUS"
TITLE="odbc_rollback"
HREF="function.odbc-rollback.html"><LINK
REL="NEXT"
TITLE="odbc_tables"
HREF="function.odbc-tables.html"><META
NAME="HTTP_EQUIV"
CONTENT="text/html; charset=ISO-8859-1"></HEAD
><BODY
CLASS="refentry"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>PHP Manual</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="function.odbc-rollback.html"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="function.odbc-tables.html"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="function.odbc-setoption"
>odbc_setoption</A
></H1
><DIV
CLASS="refnamediv"
><A
NAME="AEN26127"
></A
><P
>    (PHP3 &#62;= 3.0.6, PHP4 )</P
>odbc_setoption&nbsp;--&nbsp;
     Adjust ODBC settings. Returns false if an error occurs, otherwise
     true.
    </DIV
><DIV
CLASS="refsect1"
><A
NAME="AEN26130"
></A
><H2
>Description</H2
><DIV
CLASS="funcsynopsis"
><A
NAME="AEN26132"
></A
><P
></P
><P
><CODE
><CODE
CLASS="FUNCDEF"
>int <B
CLASS="function"
>odbc_setoption</B
></CODE
> (int id, int function, int option, int param)</CODE
></P
><P
></P
></DIV
><P
>&#13;     This function allows fiddling with the ODBC options for a
     particular connection or query result.  It was written to help
     find work arounds to problems in quirky ODBC drivers.  You should
     probably only use this function if you are an ODBC programmer and
     understand the effects the various options will have.  You will
     certainly need a good ODBC reference to explain all the different
     options and values that can be used.  Different driver versions
     support different options.
    </P
><P
>&#13;     Because the effects may vary depending on the ODBC driver, use of
     this function in scripts to be made publicly available is
     strongly discouraged.  Also, some ODBC options are not available
     to this function because they must be set before the connection
     is established or the query is prepared.  However, if on a
     particular job it can make PHP work so your boss doesn't tell you
     to use a commercial product, that's all that really
     matters.
    </P
><P
>&#13;     <TT
CLASS="parameter"
><I
>ID</I
></TT
> is a connection id or result id on
     which to change the settings.For SQLSetConnectOption(), this is a
     connection id. For SQLSetStmtOption(), this is a result
     id.
    </P
><P
>&#13;     <TT
CLASS="parameter"
><I
>Function</I
></TT
> is the ODBC function to use. The
     value should be 1 for SQLSetConnectOption() and 2 for
     SQLSetStmtOption().
    </P
><P
>&#13;     Parameter <TT
CLASS="parameter"
><I
>option</I
></TT
> is the option to set.</P
><P
>&#13;     Parameter <TT
CLASS="parameter"
><I
>param</I
></TT
> is the value for the
     given <TT
CLASS="parameter"
><I
>option</I
></TT
>.
     <TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
CLASS="EXAMPLE"
><TR
><TD
><DIV
CLASS="example"
><A
NAME="AEN26155"
></A
><P
><B
>Example 1. ODBC Setoption Examples</B
></P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="programlisting"
>&#13;// 1. Option 102 of SQLSetConnectOption() is SQL_AUTOCOMMIT.
//    Value 1 of SQL_AUTOCOMMIT is SQL_AUTOCOMMIT_ON.
//    This example has the same effect as
//    odbc_autocommit($conn, true);

odbc_setoption ($conn, 1, 102, 1);

// 2. Option 0 of SQLSetStmtOption() is SQL_QUERY_TIMEOUT.
//    This example sets the query to timeout after 30 seconds.

$result = odbc_prepare ($conn, $sql);
odbc_setoption ($result, 2, 0, 30);
odbc_execute ($result);
      </PRE
></TD
></TR
></TABLE
></DIV
></TD
></TR
></TABLE
>
    </P
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="function.odbc-rollback.html"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="manual.html"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="function.odbc-tables.html"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>odbc_rollback</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="ref.odbc.html"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>odbc_tables</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>