ImageGetIPTCTag

Description

Retrieves the value of the IPTC tag for a ColdFusion image.

Returns

The value of the IPTC tag.

Category

Image functions

Function syntax

ImageGetIPTCTag(name, tagName)

See also

cfimage, ImageGetBlob, ImageGetBufferedImage, ImageGetEXIFMetadata, ImageGetEXIFTag, ImageGetHeight, ImageGetIPTCMetadata, ImageGetWidth, ImageInfo, IsImage, IsImageFile

History

ColdFusion 8: Added this function.

Parameters

Parameter

Description

name

Required. The ColdFusion image on which this operation is performed.

tagName

Required. The IPTC tag name whose value is returned.

Usage

The ImageGetIPTCTag function applies only to JPEG images. If you try to retrieve metadata for Base64, BLOB, or other image types, ColdFusion generates errors.

Example

<!--- This example shows how to retrieve the caption for a JPEG file. ---> 
<!--- Create a ColdFusion image from a JPEG file. ---> 
<cfimage source="../cfdocs/images/artgallery/paul05.jpg" name="myImage" action="read"> 
<!--- Retrieve the camera make used to take the original picture. ---> 
<cfset cameraMake=ImageGetIPTCTag(myImage,"make")> 
<cfdump var="#cameraMake#>"