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

<refentry xml:id="sqlite3.querysingle" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">

<refnamediv>

<refname>SQLite3::querySingle</refname>

<refpurpose>クエリを実行し、単一の結果を返す</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<methodsynopsis role="SQLite3">

<modifier>public</modifier> <type>mixed</type><methodname>SQLite3::querySingle</methodname>

<methodparam><type>string</type><parameter>query</parameter></methodparam>

<methodparam choice="opt"><type>bool</type><parameter>entireRow</parameter><initializer>&false;</initializer></methodparam>

</methodsynopsis>

<para>

クエリを実行し、単一の結果を返します。

</para>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

<term><parameter>query</parameter></term>

<listitem>

<para>

実行したい SQL クエリ。

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>entireRow</parameter></term>

<listitem>

<para>

デフォルトでは、<function>querySingle</function> はクエリが返す結果の最初のカラムの値を返します。

<parameter>entireRow</parameter> が &true; の場合は、最初の行全体を配列で返します。

</para>

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

結果の最初のカラムの値あるいは最初の行全体の配列

(<parameter>entireRow</parameter> が &true; の場合) を返します。

</para>

<para>

クエリ自体は有効であるけれども結果が返されなかった場合の戻り値は、

<parameter>entireRow</parameter> が &false; なら &null;、

そうでなければ空の配列となります。

</para>

<para>

クエリが無効な場合やクエリの実行に失敗した場合は &false; を返します。

</para>

</refsect1>

<refsect1 role="examples">

&reftitle.examples;

<para>

<example>

<title><function>SQLite3::querySingle</function> の例</title>

<programlisting role="php">

</programlisting>

&example.outputs.similar;

<screen>

</screen>

</example>

</para>

</refsect1>

</refentry>