<?xml version="1.0" encoding="utf-8"?>

<refentry xml:id="function.pg-lo-write" xmlns="http://docbook.org/ns/docbook">

<refnamediv>

<refname>pg_lo_write</refname>

<refpurpose>ラージオブジェクトに書き込む</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<methodsynopsis>

<type class="union"><type>int</type><type>false</type></type><methodname>pg_lo_write</methodname>

<methodparam><type>PgSql\Lob</type><parameter>lob</parameter></methodparam>

<methodparam><type>string</type><parameter>data</parameter></methodparam>

<methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>length</parameter><initializer>&null;</initializer></methodparam>

</methodsynopsis>

<para>

<function>pg_lo_write</function> は、ラージオブジェクトの

カレントのシーク位置にデータを書き込みます。

</para>

<para>

ラージオブジェクトインターフェイスは、トランザクションブロックの中で

使用する必要があります。

</para>

<note>

<para>

この関数は、以前は <function>pg_lowrite</function> と呼ばれていました。

</para>

</note>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

<term><parameter>lob</parameter></term>

<listitem>

&pgsql.parameter.lob;

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>data</parameter></term>

<listitem>

<para>

ラージオブジェクトに書き込むデータ。<parameter>length</parameter> が

数値で、かつ <parameter>data</parameter> の長さより小さく指定されている場合、

<parameter>length</parameter> バイトのみが書き込まれます。

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>length</parameter></term>

<listitem>

<para>

書き込むデータの最大バイト数（オプション）。0 より大きく、かつ

<parameter>data</parameter> のサイズ以下でなければなりません。

デフォルトは <parameter>data</parameter> の長さです。

</para>

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

ラージオブジェクトに書き込んだバイト数を返します。

エラー時には &false; を返します。

</para>

</refsect1>

<refsect1 role="changelog">

&reftitle.changelog;

<informaltable>

<tgroup cols="2">

<thead>

<row>

<entry>&Version;</entry>

<entry>&Description;</entry>

</row>

</thead>

<tbody>

&pgsql.changelog.lob-object;

<row>

<entry>8.0.0</entry>

<entry>

<parameter>length</parameter> は、nullable になりました。

</entry>

</row>

</tbody>

</tgroup>

</informaltable>

</refsect1>

<refsect1 role="examples">

&reftitle.examples;

<para>

<example>

<title><function>pg_lo_write</function> の例</title>

<programlisting role="php">

</programlisting>

</example>

</para>

</refsect1>

<refsect1 role="seealso">

&reftitle.seealso;

<para>

<simplelist>

<member><function>pg_lo_create</function></member>

<member><function>pg_lo_open</function></member>

</simplelist>

</para>

</refsect1>

</refentry>