lo_unlink documentation error

From: Warwick Hunter <whunter(at)agile(dot)tv>
To: pgsql-bugs(at)postgresql(dot)org
Subject: lo_unlink documentation error
Date: 2002-04-18 00:20:22
Message-ID: 3CBE1146.30702@oz.agile.tv
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-bugs

I noticed a small but misleading documentation error.

/usr/share/doc/postgresql-7.2/html/lo-interfaces.html
======================================================
2.3.9. Removing a Large Object

To remove a large object from the database, call

Oid lo_unlink(PGconn *conn, Oid lobjId)

The lobjId argument specifies the OID of the large object to remove.
======================================================
The return value for lo_unlink is described in the documentation as Oid.

In the header file /usr/include/libpq-fe.h
======================================================

/* === in fe-lobj.c === */

/* Large-object access routines */
...
extern int lo_unlink(PGconn *conn, Oid lobjId);
...
======================================================
The return value for lo_unlink is defined as an int.

Presumably the header file is correct. Perhaps the
documentation should read like lo_close:

"On success, lo_unlink returns zero. On error, the return value is
negative."

Warwick
--
Warwick Hunter Agile TV Corporation
Voice: +61 7 5584 5912 Fax: +61 7 5575 9550
mailto:whunter(at)oz(dot)agile(dot)tv http://www.agile.tv

Responses

Browse pgsql-bugs by date

  From Date Subject
Next Message Bruce Momjian 2002-04-18 03:29:28 Re: [PATCHES] A bug in gist code with fetch/move
Previous Message Bruce Momjian 2002-04-18 00:08:44 Re: Bug #634: PG_DUMP Files do not restore on PostgreSQL 7.2.1