<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Exiv2: Exiv2::IptcParser Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.9 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
<li>
<form action="search.php" method="get">
<table cellspacing="0" cellpadding="0" border="0">
<tr>
<td><label> <u>S</u>earch for </label></td>
<td><input type="text" name="query" value="" size="20" accesskey="s"/></td>
</tr>
</table>
</form>
</li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="namespaceExiv2.html">Exiv2</a>::<a class="el" href="classExiv2_1_1IptcParser.html">IptcParser</a>
</div>
</div>
<div class="contents">
<h1>Exiv2::IptcParser Class Reference</h1><!-- doxytag: class="Exiv2::IptcParser" -->Stateless parser class for IPTC data. Images use this class to decode and encode binary IPTC data.
<a href="#_details">More...</a>
<p>
<code>#include <iptc.hpp></code>
<p>
<p>
<a href="classExiv2_1_1IptcParser-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1IptcParser.html#5284a756c97571f0fd1de6c59f5cc2ac">decode</a> (<a class="el" href="classExiv2_1_1IptcData.html">IptcData</a> &iptcData, const <a class="el" href="namespaceExiv2.html#16f60a5bd4207fe155f6cf93a15efa72">byte</a> *pData, uint32_t size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Decode binary IPTC data in IPTC IIM4 format from a buffer <em>pData</em> of length <em>size</em> to the provided metadata container. <a href="#5284a756c97571f0fd1de6c59f5cc2ac"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classExiv2_1_1DataBuf.html">DataBuf</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1IptcParser.html#de6b61bc6ce95b24c2c0b47575f1c20a">encode</a> (const <a class="el" href="classExiv2_1_1IptcData.html">IptcData</a> &iptcData)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Encode the IPTC datasets from <em>iptcData</em> to a binary representation in IPTC IIM4 format. <a href="#de6b61bc6ce95b24c2c0b47575f1c20a"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Stateless parser class for IPTC data. Images use this class to decode and encode binary IPTC data. <hr><h2>Member Function Documentation</h2>
<a class="anchor" name="5284a756c97571f0fd1de6c59f5cc2ac"></a><!-- doxytag: member="Exiv2::IptcParser::decode" ref="5284a756c97571f0fd1de6c59f5cc2ac" args="(IptcData &iptcData, const byte *pData, uint32_t size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Exiv2::IptcParser::decode </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classExiv2_1_1IptcData.html">IptcData</a> & </td>
<td class="paramname"> <em>iptcData</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="namespaceExiv2.html#16f60a5bd4207fe155f6cf93a15efa72">byte</a> * </td>
<td class="paramname"> <em>pData</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"> <em>size</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Decode binary IPTC data in IPTC IIM4 format from a buffer <em>pData</em> of length <em>size</em> to the provided metadata container.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>iptcData</em> </td><td>Metadata container to add the decoded IPTC datasets to. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>pData</em> </td><td>Pointer to the data buffer to read from. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>Number of bytes in the data buffer.</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 if successful;<br>
5 if the binary IPTC data is invalid or corrupt </dd></dl>
<p>References <a class="el" href="iptc_8hpp_source.html#l00260">Exiv2::IptcData::clear()</a>, and <a class="el" href="types_8cpp_source.html#l00181">Exiv2::getUShort()</a>.</p>
<p>Referenced by <a class="el" href="tiffvisitor_8cpp_source.html#l00306">Exiv2::Internal::TiffDecoder::decodeIptc()</a>, and <a class="el" href="jp2image_8cpp_source.html#l00147">Exiv2::Jp2Image::readMetadata()</a>.</p>
</div>
</div><p>
<a class="anchor" name="de6b61bc6ce95b24c2c0b47575f1c20a"></a><!-- doxytag: member="Exiv2::IptcParser::encode" ref="de6b61bc6ce95b24c2c0b47575f1c20a" args="(const IptcData &iptcData)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classExiv2_1_1DataBuf.html">DataBuf</a> Exiv2::IptcParser::encode </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classExiv2_1_1IptcData.html">IptcData</a> & </td>
<td class="paramname"> <em>iptcData</em> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Encode the IPTC datasets from <em>iptcData</em> to a binary representation in IPTC IIM4 format.
<p>
Convert the IPTC datasets to binary format and return it. Caller owns the returned buffer. The copied data follows the IPTC IIM4 standard.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Data buffer containing the binary IPTC data in IPTC IIM4 format. </dd></dl>
<p>References <a class="el" href="iptc_8hpp_source.html#l00266">Exiv2::IptcData::begin()</a>, <a class="el" href="iptc_8hpp_source.html#l00268">Exiv2::IptcData::end()</a>, <a class="el" href="iptc_8cpp_source.html#l00158">Exiv2::IptcData::size()</a>, <a class="el" href="types_8cpp_source.html#l00252">Exiv2::ul2Data()</a>, and <a class="el" href="types_8cpp_source.html#l00239">Exiv2::us2Data()</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="iptc_8hpp.html">iptc.hpp</a><li>iptc.cpp</ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Jun 25 15:17:58 2009 for Exiv2 by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
</body>
</html>
