Thread: ECPGstatus documentation

ECPGstatus documentation

From
Edmund Bacon
Date:
I've just spent a half hour or so trying to figure out why a call to 
ECPGstatus() was complaining about the wrong number of arguments.  The 
documentation states:

ECPGstatus() returns true if you are connected to a database and false 
if not.

However, digging through the archives, I found the following from Jan 7, 
2000:
> ECPGstatus() seems to have changed to ECPGstatus (int, const char);> What exactly am I supposed to pass to this
function?

The first argument is the line-number (i.e. __LINE__). The second is the
connection name. If you do not have different connections you can use 
NULL as connection name or just use "CURRENT".

Michael

So, could either the documentation be updated to reflect the correct 
parameters to ECPGstatus() or perhaps 
src/interfaces/ecpg/preproc/preproc.y can be patched to Do The Right 
Thing?  If I had any experience with bison/yacc/lex/flex/whatever, I'd 
take a look at it, but as I don't ... :-(

Thanks.

-- 
Edmund Bacon <ebacon@onesystem.com>


Re: ECPGstatus documentation

From
Bruce Momjian
Date:
OK, fixed, patch applied and attached.  Are there any other ecpg
documentation additions needed?

---------------------------------------------------------------------------

Edmund Bacon wrote:
> I've just spent a half hour or so trying to figure out why a call to
> ECPGstatus() was complaining about the wrong number of arguments.  The
> documentation states:
>
> ECPGstatus() returns true if you are connected to a database and false
> if not.
>
> However, digging through the archives, I found the following from Jan 7,
> 2000:
>
>  > ECPGstatus() seems to have changed to ECPGstatus (int, const char);
>  > What exactly am I supposed to pass to this function?
>
> The first argument is the line-number (i.e. __LINE__). The second is the
> connection name. If you do not have different connections you can use
> NULL as connection name or just use "CURRENT".
>
> Michael
>
> So, could either the documentation be updated to reflect the correct
> parameters to ECPGstatus() or perhaps
> src/interfaces/ecpg/preproc/preproc.y can be patched to Do The Right
> Thing?  If I had any experience with bison/yacc/lex/flex/whatever, I'd
> take a look at it, but as I don't ... :-(
>
> Thanks.
>
> --
> Edmund Bacon <ebacon@onesystem.com>
>
> ---------------------------(end of broadcast)---------------------------
> TIP 4: Don't 'kill -9' the postmaster
>

--
  Bruce Momjian                        |  http://candle.pha.pa.us
  pgman@candle.pha.pa.us               |  (610) 359-1001
  +  If your life is a hard drive,     |  13 Roberts Road
  +  Christ can be your backup.        |  Newtown Square, Pennsylvania 19073
Index: doc/src/sgml/ecpg.sgml
===================================================================
RCS file: /cvsroot/pgsql/doc/src/sgml/ecpg.sgml,v
retrieving revision 1.60
diff -c -c -r1.60 ecpg.sgml
*** doc/src/sgml/ecpg.sgml    28 Dec 2004 22:47:15 -0000    1.60
--- doc/src/sgml/ecpg.sgml    7 Jan 2005 05:42:27 -0000
***************
*** 1610,1617 ****

     <listitem>
      <para>
!      <function>ECPGstatus()</function> returns true if you
!      are connected to a database and false if not.
      </para>
     </listitem>
    </itemizedlist>
--- 1610,1620 ----

     <listitem>
      <para>
!      <function>ECPGstatus(int <replaceable>lineno</replaceable>,
!      const char* <replaceable>connection_name</replaceable>)</function>
!      returns true if you are connected to a database and false if not.
!      <replaceable>connection_name</replaceable> can be <literal>NULL</>
!      if a single connection is being used.
      </para>
     </listitem>
    </itemizedlist>