Skip to content

Commit a455860

Browse files
[PHP 8.4] Add manual for pg_result_memory_syze() (#145)
* [PHP 8.4] Add manual for `pg_result_memory_syze()` * remove `<para>` * xmlの書式スタイルをenと揃える * 英語版リビジョンとクレジットの追加 --------- Co-authored-by: 武田 憲太郎 <[email protected]>
1 parent c9927a5 commit a455860

File tree

1 file changed

+95
-0
lines changed

1 file changed

+95
-0
lines changed
Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<!-- $Revision$ -->
3+
<!-- EN-Revision: 0e3624a28232422c0e6741b93f93599726479bb3 Maintainer: KentarouTakeda Status: ready -->
4+
<!-- CREDITS: KentarouTakeda -->
5+
<refentry xml:id="function.pg-result-memory-size" xmlns="http://docbook.org/ns/docbook">
6+
<refnamediv>
7+
<refname>pg_result_memory_size</refname>
8+
<refpurpose>クエリーの結果に割り当てられたメモリ使用量を返します</refpurpose>
9+
</refnamediv>
10+
11+
<refsect1 role="description">
12+
&reftitle.description;
13+
<methodsynopsis>
14+
<type>int</type><methodname>pg_result_memory_size</methodname>
15+
<methodparam><type>PgSql\Result</type><parameter>result</parameter></methodparam>
16+
</methodsynopsis>
17+
<simpara>
18+
指定されたクエリ結果 <classname>PgSql\Result</classname> インスタンスに割り当てられたメモリ使用量をバイト単位で返します。
19+
この値は、 <function>pg_free_result</function> によって解放されるメモリ使用量と同じです。
20+
</simpara>
21+
</refsect1>
22+
23+
<refsect1 role="parameters">
24+
&reftitle.parameters;
25+
<variablelist>
26+
<varlistentry>
27+
<term><parameter>result</parameter></term>
28+
<listitem>
29+
&pgsql.parameter.result;
30+
</listitem>
31+
</varlistentry>
32+
</variablelist>
33+
</refsect1>
34+
35+
<refsect1 role="returnvalues">
36+
&reftitle.returnvalues;
37+
<simpara>
38+
メモリ使用量をバイト単位で返します。
39+
</simpara>
40+
</refsect1>
41+
42+
<refsect1 role="examples">
43+
&reftitle.examples;
44+
<example>
45+
<title><function>pg_result_memory_size</function> の例</title>
46+
<programlisting role="php">
47+
<![CDATA[
48+
<?php
49+
$db = pg_connect("dbname=users user=me");
50+
51+
$res = pg_query($db, 'SELECT 1');
52+
53+
$size = pg_result_memory_size($res);
54+
55+
var_dump($size);
56+
?>
57+
]]>
58+
</programlisting>
59+
&example.outputs.similar;
60+
<screen>
61+
<![CDATA[
62+
int(3288)
63+
]]>
64+
</screen>
65+
</example>
66+
</refsect1>
67+
68+
<refsect1 role="seealso">
69+
&reftitle.seealso;
70+
<simplelist>
71+
<member><function>pg_free_result</function></member>
72+
</simplelist>
73+
</refsect1>
74+
</refentry>
75+
76+
<!-- Keep this comment at the end of the file
77+
Local variables:
78+
mode: sgml
79+
sgml-omittag:t
80+
sgml-shorttag:t
81+
sgml-minimize-attributes:nil
82+
sgml-always-quote-attributes:t
83+
sgml-indent-step:1
84+
sgml-indent-data:t
85+
indent-tabs-mode:nil
86+
sgml-parent-document:nil
87+
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
88+
sgml-exposed-tags:nil
89+
sgml-local-catalogs:nil
90+
sgml-local-ecat-files:nil
91+
End:
92+
vim600: syn=xml fen fdm=syntax fdl=2 si
93+
vim: et tw=78 syn=sgml
94+
vi: ts=1 sw=1
95+
-->

0 commit comments

Comments
 (0)