reference/gmp/functions/gmp-export.xml
548548299328e56739eb2832a5c22ba2de745038
548548299328e56739eb2832a5c22ba2de745038
...
...
@@ -1,6 +1,6 @@
1
1
<?xml version="1.0" encoding="utf-8"?>
2
2
<!-- $Revision$ -->
3
-
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.gmp-export">
3
+
<refentry xml:id="function.gmp-export" xmlns="http://docbook.org/ns/docbook">
4
4
<refnamediv>
5
5
<refname>gmp_export</refname>
6
6
<refpurpose>Export to a binary string</refpurpose>
...
...
@@ -10,9 +10,9 @@
10
10
&reftitle.description;
11
11
<methodsynopsis>
12
12
<type>string</type><methodname>gmp_export</methodname>
13
-
<methodparam><type>GMP</type><parameter>gmpnumber</parameter></methodparam>
14
-
<methodparam><type>integer</type><parameter>word_size</parameter></methodparam>
15
-
<methodparam><type>integer</type><parameter>options</parameter></methodparam>
13
+
<methodparam><type class="union"><type>GMP</type><type>int</type><type>string</type></type><parameter>num</parameter></methodparam>
14
+
<methodparam choice="opt"><type>int</type><parameter>word_size</parameter><initializer>1</initializer></methodparam>
15
+
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>GMP_MSW_FIRST | GMP_NATIVE_ENDIAN</initializer></methodparam>
16
16
</methodsynopsis>
17
17
<para>
18
18
Export a GMP number to a binary string
...
...
@@ -24,7 +24,7 @@
24
24
<para>
25
25
<variablelist>
26
26
<varlistentry>
27
-
<term><parameter>gmpnumber</parameter></term>
27
+
<term><parameter>num</parameter></term>
28
28
<listitem>
29
29
<para>
30
30
The GMP number being exported
...
...
@@ -40,10 +40,10 @@
40
40
</listitem>
41
41
</varlistentry>
42
42
<varlistentry>
43
-
<term><parameter>options</parameter></term>
43
+
<term><parameter>flags</parameter></term>
44
44
<listitem>
45
45
<para>
46
-
Default value is GMP_MSW_FIRST | GMP_NATIVE_ENDIAN.
46
+
Default value is <constant>GMP_MSW_FIRST</constant> | <constant>GMP_NATIVE_ENDIAN</constant>.
47
47
</para>
48
48
</listitem>
49
49
</varlistentry>
...
...
@@ -54,10 +54,32 @@
54
54
<refsect1 role="returnvalues">
55
55
&reftitle.returnvalues;
56
56
<para>
57
-
Returns a string&return.falseforfailure;.
57
+
Returns a string.
58
58
</para>
59
59
</refsect1>
60
60
61
+
<refsect1 role="changelog">
62
+
&reftitle.changelog;
63
+
<informaltable>
64
+
<tgroup cols="2">
65
+
<thead>
66
+
<row>
67
+
<entry>&Version;</entry>
68
+
<entry>&Description;</entry>
69
+
</row>
70
+
</thead>
71
+
<tbody>
72
+
<row>
73
+
<entry>8.0.0</entry>
74
+
<entry>
75
+
This function no longer returns &false; on failure.
76
+
</entry>
77
+
</row>
78
+
</tbody>
79
+
</tgroup>
80
+
</informaltable>
81
+
</refsect1>
82
+
61
83
<refsect1 role="examples">
62
84
&reftitle.examples;
63
85
<para>
...
...
@@ -80,8 +102,17 @@ AA
80
102
</example>
81
103
</para>
82
104
</refsect1>
83
-
</refentry>
84
105
106
+
<refsect1 role="seealso">
107
+
&reftitle.seealso;
108
+
<para>
109
+
<simplelist>
110
+
<member><function>gmp_import</function></member>
111
+
</simplelist>
112
+
</para>
113
+
</refsect1>
114
+
115
+
</refentry>
85
116
<!-- Keep this comment at the end of the file
86
117
Local variables:
87
118
mode: sgml
88
119