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

<refentry xml:id="domnode.insertbefore" xmlns="http://docbook.org/ns/docbook">

<refnamediv>

<refname>DOMNode::insertBefore</refname>

<refpurpose>

参照しているノードの前に新しい子を追加する

</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<methodsynopsis role="DOMNode">

<modifier>public</modifier> <type class="union"><type>DOMNode</type><type>false</type></type><methodname>DOMNode::insertBefore</methodname>

<methodparam><type>DOMNode</type><parameter>node</parameter></methodparam>

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

</methodsynopsis>

<para>

この関数は、参照しているノードの直前に新しいノードを挿入します。

追加するノードに対して変更を加えたい場合は、この関数から返される

ノードを使用します。

</para>

<para>

既存のノードを使う場合、そのノードは移動します。

</para>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

<term><parameter>node</parameter></term>

<listitem>

<para>

新しいノード。

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>child</parameter></term>

<listitem>

<para>

参照ノード。指定されなかった場合は、<parameter>node</parameter>

が子要素として追加されます。

</para>

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

挿入されたノードを返します。

エラーの場合は &false; を返します。

</para>

</refsect1>

<refsect1 role="errors">

&reftitle.errors;

<simpara>

以下のエラーコードで <exceptionname>DOMException</exceptionname>

をスローします:

</simpara>

<para>

<variablelist>

<varlistentry>

<term><constant>DOM_NO_MODIFICATION_ALLOWED_ERR</constant></term>

<listitem>

<para>

このノードが読み込み専用であったり、挿入されるノードの以前の親が

読み込み専用であった場合に発生します。

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><constant>DOM_HIERARCHY_REQUEST_ERR</constant></term>

<listitem>

<para>

<parameter>node</parameter> で指定した型の子ノードを

保持することが許可されていない場合、あるいは追加しようとしている

ノードが自分自身やその祖先であった場合に発生します。

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><constant>DOM_WRONG_DOCUMENT_ERR</constant></term>

<listitem>

<para>

<parameter>node</parameter> が、このノードとは別の

ドキュメントで作成されたものである場合に発生します。

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><constant>DOM_NOT_FOUND_ERR</constant></term>

<listitem>

<para>

<parameter>child</parameter> がこのノードの子ではない場合に

発生します。

</para>

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="seealso">

&reftitle.seealso;

<para>

<simplelist>

<member><methodname>DOMNode::appendChild</methodname></member>

</simplelist>

</para>

</refsect1>

</refentry>