reference/image/functions/imagegrabwindow.xml
180ed02e4b694873316c707014e1aaf68ebf6a04
...
...
@@ -9,13 +9,18 @@
9
9
<refsect1 role="description">
10
10
&reftitle.description;
11
11
<methodsynopsis>
12
-
<type>resource</type><methodname>imagegrabwindow</methodname>
13
-
<methodparam><type>int</type><parameter>window_handle</parameter></methodparam>
14
-
<methodparam choice="opt"><type>int</type><parameter>client_area</parameter><initializer>0</initializer></methodparam>
12
+
<type class="union"><type>GdImage</type><type>false</type></type><methodname>imagegrabwindow</methodname>
13
+
<methodparam><type>int</type><parameter>handle</parameter></methodparam>
14
+
<methodparam choice="opt"><type>bool</type><parameter>client_area</parameter><initializer>&false;</initializer></methodparam>
15
15
</methodsynopsis>
16
16
<para>
17
17
Grabs a window or its client area using a windows handle (HWND property in COM instance)
18
18
</para>
19
+
<note>
20
+
<para>
21
+
This function is only available on Windows.
22
+
</para>
23
+
</note>
19
24
</refsect1>
20
25

21
26
<refsect1 role="parameters">
...
...
@@ -23,7 +28,7 @@
23
28
<para>
24
29
<variablelist>
25
30
<varlistentry>
26
-
<term><parameter>window_handle</parameter></term>
31
+
<term><parameter>handle</parameter></term>
27
32
<listitem>
28
33
<para>
29
34
The HWND window ID.
...
...
@@ -45,19 +50,49 @@
45
50
<refsect1 role="returnvalues">
46
51
&reftitle.returnvalues;
47
52
<para>
48
-
Returns an image resource identifier on success, &false; on failure.
53
+
Returns an image object on success, &false; on failure.
49
54
</para>
50
55
</refsect1>
51
56

52
57
<refsect1 role="errors">
53
58
&reftitle.errors;
54
59
<para>
55
-
E_NOTICE is issued if <parameter>window_handle</parameter> is invalid
60
+
E_NOTICE is issued if <parameter>handle</parameter> is invalid
56
61
window handle.
57
62
E_WARNING is issued if the Windows API is too old.
58
63
</para>
59
64
</refsect1>
60
65

66
+
<refsect1 role="changelog">
67
+
&reftitle.changelog;
68
+
<informaltable>
69
+
<tgroup cols="2">
70
+
<thead>
71
+
<row>
72
+
<entry>&Version;</entry>
73
+
<entry>&Description;</entry>
74
+
</row>
75
+
</thead>
76
+
<tbody>
77
+
<row>
78
+
<entry>8.0.0</entry>
79
+
<entry>
80
+
On success, this function returns a <classname>GDImage</classname> instance now;
81
+
previously, a <type>resource</type> was returned.
82
+
</entry>
83
+
</row>
84
+
<row>
85
+
<entry>8.0.0</entry>
86
+
<entry>
87
+
<parameter>client_area</parameter> expects a <type>bool</type> now;
88
+
previously it expected an <type>int</type>.
89
+
</entry>
90
+
</row>
91
+
</tbody>
92
+
</tgroup>
93
+
</informaltable>
94
+
</refsect1>
95
+

61
96
<refsect1 role="examples">
62
97
&reftitle.examples;
63
98
<para>
...
...
@@ -105,25 +140,13 @@ imagedestroy($im);
105
140
</para>
106
141
</refsect1>
107
142

108
-
<refsect1 role="notes">
109
-
&reftitle.notes;
110
-
<note>
111
-
<para>
112
-
This function is only available on Windows.
113
-
</para>
114
-
</note>
115
-
</refsect1>
116
-

117
143
<refsect1 role="seealso">
118
144
&reftitle.seealso;
119
-
<para>
120
-
<simplelist>
121
-
<member><function>imagegrabscreen</function></member>
122
-
</simplelist>
123
-
</para>
145
+
<simplelist>
146
+
<member><function>imagegrabscreen</function></member>
147
+
</simplelist>
124
148
</refsect1>
125
149
</refentry>
126
-

127
150
<!-- Keep this comment at the end of the file
128
151
Local variables:
129
152
mode: sgml
...
...
@@ -144,4 +167,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
144
167
vim: et tw=78 syn=sgml
145
168
vi: ts=1 sw=1
146
169
-->
147
-

148
170