Function __global->iptcembed

Definitions

sources_custom/phpstub.php

  • Embed an IPTC block in a JPEG file.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$iptcdata string No No required parameter N/A N/A The data to be written
$jpeg_file_name PATH No No required parameter N/A N/A Path to the JPEG image
$spool integer No No 0 N/A N/A Spool flag. If the spool flag is less than 2 then the JPEG will be returned as a string. Otherwise the JPEG will be printed to STDOUT.

Returns

  • If spool is less than 2, the JPEG will be returned, or FALSE on failure. Otherwise returns TRUE on success or FALSE on failure.
  • Type: mixed
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Embed an IPTC block in a JPEG file.
 *
 * @param  string $iptcdata The data to be written
 * @param  PATH $jpeg_file_name Path to the JPEG image
 * @param  integer $spool Spool flag. If the spool flag is less than 2 then the JPEG will be returned as a string. Otherwise the JPEG will be printed to STDOUT.
 * @return mixed If spool is less than 2, the JPEG will be returned, or FALSE on failure. Otherwise returns TRUE on success or FALSE on failure.
 */
function iptcembed(string $iptcdata, string $jpeg_file_name, int $spool = 0)