<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML
><HEAD
><TITLE
>pg_lo_creat</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.7"><LINK
REL="HOME"
TITLE="Pgtcl Reference Manual"
HREF="index.html"><LINK
REL="UP"
TITLE="Large Object Processing Commands"
HREF="pgtcl-ref-largeobj.html"><LINK
REL="PREVIOUS"
TITLE="Large Object Processing Commands"
HREF="pgtcl-ref-largeobj.html"><LINK
REL="NEXT"
TITLE="pg_lo_open"
HREF="pg-lo-open.html"><LINK
REL="STYLESHEET"
TYPE="text/css"
HREF="stylesheet.css"><META
NAME="creation"
CONTENT="2004-11-09T00:53:06"></HEAD
><BODY
CLASS="REFENTRY"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>Pgtcl Reference Manual: The PostgreSQL Tcl Interface</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="pgtcl-ref-largeobj.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="pg-lo-open.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="PG-LO-CREAT"
></A
>pg_lo_creat</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN2144"
></A
><H2
>Name</H2
>pg_lo_creat -- create a large object</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN2147"
></A
><H2
>Synopsis</H2
><PRE
CLASS="SYNOPSIS"
>pg_lo_creat <VAR
CLASS="PARAMETER"
>conn</VAR
> <VAR
CLASS="PARAMETER"
>mode</VAR
></PRE
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN2151"
></A
><H2
>Description</H2
><P
> <CODE
CLASS="FUNCTION"
>pg_lo_creat</CODE
> creates a large object.
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN2155"
></A
><H2
>Arguments</H2
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
><VAR
CLASS="REPLACEABLE"
>conn</VAR
></DT
><DD
><P
> The handle of a connection to the database in which to create the
large object.
</P
></DD
><DT
><VAR
CLASS="REPLACEABLE"
>mode</VAR
></DT
><DD
><P
>The access mode for the large object. It can be any or'ing
together of <TT
CLASS="LITERAL"
>INV_READ</TT
> and <TT
CLASS="LITERAL"
>INV_WRITE</TT
>. The
<SPAN
CLASS="QUOTE"
>"or"</SPAN
> operator is <TT
CLASS="LITERAL"
>|</TT
>. For example:
</P><PRE
CLASS="PROGRAMLISTING"
>[pg_lo_creat $conn "INV_READ|INV_WRITE"]</PRE
><P>
</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN2173"
></A
><H2
>Return Value</H2
><P
> The OID of the large object created.
</P
><P
> A Tcl error will be thrown if an error occurs.
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN2177"
></A
><H2
>Notes</H2
><P
> All large object manipulation must take place within an SQL transaction
block.
</P
><P
> This command uses or emulates the <SPAN
CLASS="PRODUCTNAME"
>PostgreSQL</SPAN
>
<SPAN
CLASS="APPLICATION"
>libpq</SPAN
>
function <CODE
CLASS="FUNCTION"
>lo_creat</CODE
>.
</P
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="pgtcl-ref-largeobj.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
ACCESSKEY="H"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="pg-lo-open.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>Large Object Processing Commands</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="pgtcl-ref-largeobj.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>pg_lo_open</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>
