<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Captures a window</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.imagegrabscreen.html">imagegrabscreen</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.imageinterlace.html">imageinterlace</a></div>
<div class="up"><a href="ref.image.html">GD and Image Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.imagegrabwindow" class="refentry">
<div class="refnamediv">
<h1 class="refname">imagegrabwindow</h1>
<p class="verinfo">(PHP 5 >= 5.2.2)</p><p class="refpurpose"><span class="refname">imagegrabwindow</span> — <span class="dc-title">Captures a window</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.imagegrabwindow-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">resource</span> <span class="methodname"><strong>imagegrabwindow</strong></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$window_handle</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$client_area</code><span class="initializer"> = 0</span></span>
] )</div>
<p class="para rdfs-comment">
Grabs a window or its client area using a windows handle (HWND property in COM instance)
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.imagegrabwindow-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">window_handle</code></em></span>
<dd>
<p class="para">
The HWND window ID.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">client_area</code></em></span>
<dd>
<p class="para">
Include the client area of the application window.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.imagegrabwindow-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns an image resource identifier on success, <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 errors" id="refsect1-function.imagegrabwindow-errors">
<h3 class="title">Errors/Exceptions</h3>
<p class="para">
E_NOTICE is issued if <em><code class="parameter">window_handle</code></em> is invalid
window handle.
E_WARNING is issued if the Windows API is too old.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.imagegrabwindow-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-3252">
<p><strong>Example #1 <span class="function"><strong>imagegrabwindow()</strong></span> example</strong></p>
<div class="example-contents"><p>
Capture a window (IE for example)
</p></div>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$browser </span><span style="color: #007700">= new </span><span style="color: #0000BB">COM</span><span style="color: #007700">(</span><span style="color: #DD0000">"InternetExplorer.Application"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$handle </span><span style="color: #007700">= </span><span style="color: #0000BB">$browser</span><span style="color: #007700">-></span><span style="color: #0000BB">HWND</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$browser</span><span style="color: #007700">-></span><span style="color: #0000BB">Visible </span><span style="color: #007700">= </span><span style="color: #0000BB">true</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$im </span><span style="color: #007700">= </span><span style="color: #0000BB">imagegrabwindow</span><span style="color: #007700">(</span><span style="color: #0000BB">$handle</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$browser</span><span style="color: #007700">-></span><span style="color: #0000BB">Quit</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">imagepng</span><span style="color: #007700">(</span><span style="color: #0000BB">$im</span><span style="color: #007700">, </span><span style="color: #DD0000">"iesnap.png"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">imagedestroy</span><span style="color: #007700">(</span><span style="color: #0000BB">$im</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>
Capture a window (IE for example) but with its content
</p></div>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$browser </span><span style="color: #007700">= new </span><span style="color: #0000BB">COM</span><span style="color: #007700">(</span><span style="color: #DD0000">"InternetExplorer.Application"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$handle </span><span style="color: #007700">= </span><span style="color: #0000BB">$browser</span><span style="color: #007700">-></span><span style="color: #0000BB">HWND</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$browser</span><span style="color: #007700">-></span><span style="color: #0000BB">Visible </span><span style="color: #007700">= </span><span style="color: #0000BB">true</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$browser</span><span style="color: #007700">-></span><span style="color: #0000BB">Navigate</span><span style="color: #007700">(</span><span style="color: #DD0000">"http://www.libgd.org"</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/* Still working? */<br /></span><span style="color: #007700">while (</span><span style="color: #0000BB">$browser</span><span style="color: #007700">-></span><span style="color: #0000BB">Busy</span><span style="color: #007700">) {<br /> </span><span style="color: #0000BB">com_message_pump</span><span style="color: #007700">(</span><span style="color: #0000BB">4000</span><span style="color: #007700">);<br />}<br /></span><span style="color: #0000BB">$im </span><span style="color: #007700">= </span><span style="color: #0000BB">imagegrabwindow</span><span style="color: #007700">(</span><span style="color: #0000BB">$handle</span><span style="color: #007700">, </span><span style="color: #0000BB">0</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$browser</span><span style="color: #007700">-></span><span style="color: #0000BB">Quit</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">imagepng</span><span style="color: #007700">(</span><span style="color: #0000BB">$im</span><span style="color: #007700">, </span><span style="color: #DD0000">"iesnap.png"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">imagedestroy</span><span style="color: #007700">(</span><span style="color: #0000BB">$im</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 notes" id="refsect1-function.imagegrabwindow-notes">
<h3 class="title">Notes</h3>
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
This function is only available on Windows.
</p>
</p></blockquote>
</div>
<div class="refsect1 seealso" id="refsect1-function.imagegrabwindow-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.imagegrabscreen.html" class="function" rel="rdfs-seeAlso">imagegrabscreen()</a> - Captures the whole screen</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.imagegrabscreen.html">imagegrabscreen</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.imageinterlace.html">imageinterlace</a></div>
<div class="up"><a href="ref.image.html">GD and Image Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
