I386LINUX/util/I386LINUX/doc/postgresql/html/pgtcl-pglowrite.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <HTML
   3 ><HEAD
   4 ><TITLE
   5 >pg_lo_write</TITLE
   6 ><META
   7 NAME="GENERATOR"
   8 CONTENT="Modular DocBook HTML Stylesheet Version 1.7"><LINK
   9 REV="MADE"
  10 HREF="mailto:pgsql-docs@postgresql.org"><LINK
  11 REL="HOME"
  12 TITLE="PostgreSQL 7.4.1 Documentation"
  13 HREF="index.html"><LINK
  14 REL="UP"
  15 TITLE="pgtcl Command Reference"
  16 HREF="libpgtcl-ref.html"><LINK
  17 REL="PREVIOUS"
  18 TITLE="pg_lo_read"
  19 HREF="pgtcl-pgloread.html"><LINK
  20 REL="NEXT"
  21 TITLE="pg_lo_lseek"
  22 HREF="pgtcl-pglolseek.html"><LINK
  23 REL="STYLESHEET"
  24 TYPE="text/css"
  25 HREF="stylesheet.css"><META
  26 NAME="creation"
  27 CONTENT="2003-12-22T03:48:47"></HEAD
  28 ><BODY
  29 CLASS="REFENTRY"
  30 ><DIV
  31 CLASS="NAVHEADER"
  32 ><TABLE
  33 SUMMARY="Header navigation table"
  34 WIDTH="100%"
  35 BORDER="0"
  36 CELLPADDING="0"
  37 CELLSPACING="0"
  38 ><TR
  39 ><TH
  40 COLSPAN="5"
  41 ALIGN="center"
  42 VALIGN="bottom"
  43 >PostgreSQL 7.4.1 Documentation</TH
  44 ></TR
  45 ><TR
  46 ><TD
  47 WIDTH="10%"
  48 ALIGN="left"
  49 VALIGN="top"
  50 ><A
  51 HREF="pgtcl-pgloread.html"
  52 ACCESSKEY="P"
  53 >Prev</A
  54 ></TD
  55 ><TD
  56 WIDTH="10%"
  57 ALIGN="left"
  58 VALIGN="top"
  59 ><A
  60 HREF="pgtcl-pgloread.html"
  61 >Fast Backward</A
  62 ></TD
  63 ><TD
  64 WIDTH="60%"
  65 ALIGN="center"
  66 VALIGN="bottom"
  67 ></TD
  68 ><TD
  69 WIDTH="10%"
  70 ALIGN="right"
  71 VALIGN="top"
  72 ><A
  73 HREF="pgtcl-pglolseek.html"
  74 >Fast Forward</A
  75 ></TD
  76 ><TD
  77 WIDTH="10%"
  78 ALIGN="right"
  79 VALIGN="top"
  80 ><A
  81 HREF="pgtcl-pglolseek.html"
  82 ACCESSKEY="N"
  83 >Next</A
  84 ></TD
  85 ></TR
  86 ></TABLE
  87 ><HR
  88 ALIGN="LEFT"
  89 WIDTH="100%"></DIV
  90 ><H1
  91 ><A
  92 NAME="PGTCL-PGLOWRITE"
  93 ></A
  94 >pg_lo_write</H1
  95 ><DIV
  96 CLASS="REFNAMEDIV"
  97 ><A
  98 NAME="AEN23048"
  99 ></A
 100 ><H2
 101 >Name</H2
 102 >pg_lo_write&nbsp;--&nbsp;write to a large object<A
 103 NAME="IX-PGTCL-PGLOWRITE-2"
 104 ></A
 105 ></DIV
 106 ><DIV
 107 CLASS="REFSYNOPSISDIV"
 108 ><A
 109 NAME="AEN23053"
 110 ></A
 111 ><H2
 112 >Synopsis</H2
 113 ><PRE
 114 CLASS="SYNOPSIS"
 115 >pg_lo_write <VAR
 116 CLASS="PARAMETER"
 117 >conn</VAR
 118 > <VAR
 119 CLASS="PARAMETER"
 120 >descriptor</VAR
 121 > <VAR
 122 CLASS="PARAMETER"
 123 >buf</VAR
 124 > <VAR
 125 CLASS="PARAMETER"
 126 >len</VAR
 127 ></PRE
 128 ></DIV
 129 ><DIV
 130 CLASS="REFSECT1"
 131 ><A
 132 NAME="AEN23059"
 133 ></A
 134 ><H2
 135 >Description</H2
 136 ><P
 137 >   <CODE
 138 CLASS="FUNCTION"
 139 >pg_lo_write</CODE
 140 > writes at most
 141    <VAR
 142 CLASS="PARAMETER"
 143 >len</VAR
 144 > bytes from a variable
 145    <VAR
 146 CLASS="PARAMETER"
 147 >buf</VAR
 148 > to a large object.
 149   </P
 150 ></DIV
 151 ><DIV
 152 CLASS="REFSECT1"
 153 ><A
 154 NAME="AEN23065"
 155 ></A
 156 ><H2
 157 >Arguments</H2
 158 ><P
 159 ></P
 160 ><DIV
 161 CLASS="VARIABLELIST"
 162 ><DL
 163 ><DT
 164 ><VAR
 165 CLASS="PARAMETER"
 166 >conn</VAR
 167 ></DT
 168 ><DD
 169 ><P
 170 >      The handle of a connection to the database in which the large object
 171       exists.
 172      </P
 173 ></DD
 174 ><DT
 175 ><VAR
 176 CLASS="PARAMETER"
 177 >descriptor</VAR
 178 ></DT
 179 ><DD
 180 ><P
 181 >      A descriptor for the large object from
 182       <CODE
 183 CLASS="FUNCTION"
 184 >pg_lo_open</CODE
 185 >.
 186      </P
 187 ></DD
 188 ><DT
 189 ><VAR
 190 CLASS="PARAMETER"
 191 >buf</VAR
 192 ></DT
 193 ><DD
 194 ><P
 195 >      The string to write to the large object (not a variable name,
 196       but the value itself).
 197      </P
 198 ></DD
 199 ><DT
 200 ><VAR
 201 CLASS="PARAMETER"
 202 >len</VAR
 203 ></DT
 204 ><DD
 205 ><P
 206 >      The maximum number of bytes to write.  The number written will
 207       be the smaller of this value and the length of the string.
 208      </P
 209 ></DD
 210 ></DL
 211 ></DIV
 212 ></DIV
 213 ><DIV
 214 CLASS="REFSECT1"
 215 ><A
 216 NAME="AEN23089"
 217 ></A
 218 ><H2
 219 >Return Value</H2
 220 ><P
 221 >   The number of bytes actually written is returned; this will ordinarily
 222    be the same as the number requested.
 223    In event of an error, the return value is negative.
 224   </P
 225 ></DIV
 226 ><DIV
 227 CLASS="NAVFOOTER"
 228 ><HR
 229 ALIGN="LEFT"
 230 WIDTH="100%"><TABLE
 231 SUMMARY="Footer navigation table"
 232 WIDTH="100%"
 233 BORDER="0"
 234 CELLPADDING="0"
 235 CELLSPACING="0"
 236 ><TR
 237 ><TD
 238 WIDTH="33%"
 239 ALIGN="left"
 240 VALIGN="top"
 241 ><A
 242 HREF="pgtcl-pgloread.html"
 243 ACCESSKEY="P"
 244 >Prev</A
 245 ></TD
 246 ><TD
 247 WIDTH="34%"
 248 ALIGN="center"
 249 VALIGN="top"
 250 ><A
 251 HREF="index.html"
 252 ACCESSKEY="H"
 253 >Home</A
 254 ></TD
 255 ><TD
 256 WIDTH="33%"
 257 ALIGN="right"
 258 VALIGN="top"
 259 ><A
 260 HREF="pgtcl-pglolseek.html"
 261 ACCESSKEY="N"
 262 >Next</A
 263 ></TD
 264 ></TR
 265 ><TR
 266 ><TD
 267 WIDTH="33%"
 268 ALIGN="left"
 269 VALIGN="top"
 270 >pg_lo_read</TD
 271 ><TD
 272 WIDTH="34%"
 273 ALIGN="center"
 274 VALIGN="top"
 275 ><A
 276 HREF="libpgtcl-ref.html"
 277 ACCESSKEY="U"
 278 >Up</A
 279 ></TD
 280 ><TD
 281 WIDTH="33%"
 282 ALIGN="right"
 283 VALIGN="top"
 284 >pg_lo_lseek</TD
 285 ></TR
 286 ></TABLE
 287 ></DIV
 288 ></BODY
 289 ></HTML
 290 >