[PHP 8.4] Add manual for pg_result_memory_syze()

Author: Ippey

reference/pgsql/functions/pg-result-memory-size.xml

@@ -0,0 +1,94 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+<refentry xml:id="function.pg-result-memory-size" xmlns="http://docbook.org/ns/docbook">
+    <refnamediv>
+        <refname>pg_result_memory_size</refname>
+        <refpurpose>クエリーの結果に割り当てられたメモリ使用量を返します</refpurpose>
+    </refnamediv>
+
+    <refsect1 role="description">
+        &reftitle.description;
+        <methodsynopsis>
+            <type>int</type><methodname>pg_result_memory_size</methodname>
+            <methodparam><type>PgSql\Result</type><parameter>result</parameter></methodparam>
+        </methodsynopsis>
+        <simpara>
+            指定されたクエリ結果 <classname>PgSql\Result</classname> インスタンスに割り当てられたメモリ使用量をバイト単位で返します。
+            この値は、 <function>pg_free_result</function> によって解放されるメモリ使用量と同じです。
+        </simpara>
+    </refsect1>
+
+    <refsect1 role="parameters">
+        &reftitle.parameters;
+        <para>
+            <variablelist>
+                <varlistentry>
+                    <term><parameter>result</parameter></term>
+                    <listitem>
+                        &pgsql.parameter.result;
+                    </listitem>
+                </varlistentry>
+            </variablelist>
+        </para>
+    </refsect1>
+
+    <refsect1 role="returnvalues">
+        &reftitle.returnvalues;
+        <simpara>
+            メモリ使用量をバイト単位で返します。
+        </simpara>
+    </refsect1>
+
+    <refsect1 role="examples">
+        &reftitle.examples;
+        <example>
+            <title><function>pg_result_memory_size</function> の例</title>
+            <programlisting role="php">
+                <![CDATA[
+<?php
+$db = pg_connect("dbname=users user=me");
+$res = pg_query($db, 'SELECT 1');
+$size = pg_result_memory_size($res);
+var_dump($size);
+?>
+]]>
+            </programlisting>
+            &example.outputs.similar;
+            <screen>
+                <![CDATA[
+int(3288)
+]]>
+            </screen>
+        </example>
+    </refsect1>
+
+    <refsect1 role="seealso">
+        &reftitle.seealso;
+        <para>
+            <simplelist>
+                <member><function>pg_free_result</function></member>
+            </simplelist>
+        </para>
+    </refsect1>
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"~/.phpdoc/manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->