php-doc-en/reference/image/functions/imagecreatefromjpeg.xml
Hannes Magnusson bc9bd08ff7 Add image example output
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@227604 c90b9560-bf6c-de11-be94-00142212c4b1
2007-01-19 19:49:07 +00:00

102 lines
2.8 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.16 $ -->
<refentry id="function.imagecreatefromjpeg">
<refnamediv>
<refname>imagecreatefromjpeg</refname>
<refpurpose>Create a new image from file or URL</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>imagecreatefromjpeg</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
</methodsynopsis>
<para>
<function>imagecreatefromjpeg</function> returns an image identifier
representing the image obtained from the given filename.
</para>
<para>
<function>imagecreatefromjpeg</function> returns an empty string
on failure. It also outputs an error message, which unfortunately
displays as a broken link in a browser. To ease debugging the
following example will produce an error <acronym>JPEG</acronym>:
<example>
<title>Example to handle an error during creation</title>
<programlisting role="php">
<![CDATA[
<?php
function LoadJpeg($imgname)
{
$im = @imagecreatefromjpeg($imgname); /* Attempt to open */
if (!$im) { /* See if it failed */
$im = imagecreatetruecolor(150, 30); /* Create a black image */
$bgc = imagecolorallocate($im, 255, 255, 255);
$tc = imagecolorallocate($im, 0, 0, 0);
imagefilledrectangle($im, 0, 0, 150, 30, $bgc);
/* Output an errmsg */
imagestring($im, 1, 5, 5, "Error loading $imgname", $tc);
}
return $im;
}
header("Content-Type: image/jpeg");
$img = LoadJpeg("bogus.image");
imagejpeg($img);
?>
]]>
</programlisting>
&example.outputs.similar;
<screenshot>
<graphic fileref="figures/image.imagecreatefromjpeg.jpg" />
</screenshot>
</example>
</para>
&tip.fopen-wrapper;
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>filename</parameter></term>
<listitem>
<para>
Path to the JPEG image
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an image resource identifier on success, &false; on errors.
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
&note.config.jpeg;
&warn.no-win32-fopen-wrapper;
</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:"../../../../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
-->