summaryrefslogtreecommitdiff
path: root/docs/API/structXMP__PacketInfo.html
blob: 7d3f73bb8d62f3bf362ac72186df7dbac8da31c0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>XMP_PacketInfo Struct Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<img src="xmp_tagline_small.jpg" width="125" height="50" border="0"><p>
<!-- Generated by Doxygen 1.8.11 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;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>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('structXMP__PacketInfo.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structXMP__PacketInfo-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">XMP_PacketInfo Struct Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>XMP packet description.  
 <a href="structXMP__PacketInfo.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="XMP__Const_8h_source.html">XMP_Const.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a2ae03a1b3d03fa9ebc829105037155a8"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structXMP__PacketInfo.html#a2ae03a1b3d03fa9ebc829105037155a8">XMP_PacketInfo</a> ()</td></tr>
<tr class="memdesc:a2ae03a1b3d03fa9ebc829105037155a8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor.  <a href="#a2ae03a1b3d03fa9ebc829105037155a8">More...</a><br /></td></tr>
<tr class="separator:a2ae03a1b3d03fa9ebc829105037155a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a20f65fcfd0f3658ab93ff441a9d61d2c"><td class="memItemLeft" align="right" valign="top">XMP_Int64&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structXMP__PacketInfo.html#a20f65fcfd0f3658ab93ff441a9d61d2c">offset</a></td></tr>
<tr class="memdesc:a20f65fcfd0f3658ab93ff441a9d61d2c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Packet offset in the file in bytes, -1 if unknown.  <a href="#a20f65fcfd0f3658ab93ff441a9d61d2c">More...</a><br /></td></tr>
<tr class="separator:a20f65fcfd0f3658ab93ff441a9d61d2c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af526c582b66e24553f2d4b11eb714a44"><td class="memItemLeft" align="right" valign="top">XMP_Int32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structXMP__PacketInfo.html#af526c582b66e24553f2d4b11eb714a44">length</a></td></tr>
<tr class="memdesc:af526c582b66e24553f2d4b11eb714a44"><td class="mdescLeft">&#160;</td><td class="mdescRight">Packet length in the file in bytes, -1 if unknown.  <a href="#af526c582b66e24553f2d4b11eb714a44">More...</a><br /></td></tr>
<tr class="separator:af526c582b66e24553f2d4b11eb714a44"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af4f99e6a5b36b05fdf4a519421875256"><td class="memItemLeft" align="right" valign="top">XMP_Int32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structXMP__PacketInfo.html#af4f99e6a5b36b05fdf4a519421875256">padSize</a></td></tr>
<tr class="memdesc:af4f99e6a5b36b05fdf4a519421875256"><td class="mdescLeft">&#160;</td><td class="mdescRight">Packet padding size in bytes, zero if unknown.  <a href="#af4f99e6a5b36b05fdf4a519421875256">More...</a><br /></td></tr>
<tr class="separator:af4f99e6a5b36b05fdf4a519421875256"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a039ce6665fe8e08d922a46f266799f75"><td class="memItemLeft" align="right" valign="top">XMP_Uns8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structXMP__PacketInfo.html#a039ce6665fe8e08d922a46f266799f75">charForm</a></td></tr>
<tr class="memdesc:a039ce6665fe8e08d922a46f266799f75"><td class="mdescLeft">&#160;</td><td class="mdescRight">Character format using the values <code>kXMP_Char8Bit</code>, <code>kXMP_Char16BitBig</code>, etc.  <a href="#a039ce6665fe8e08d922a46f266799f75">More...</a><br /></td></tr>
<tr class="separator:a039ce6665fe8e08d922a46f266799f75"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a66845c1d5f3f9f36a1543a7322bd7bd1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="XMP__Const_8h.html#a0cf68b6f47d136ed571a441a9e0d2248">XMP_Bool</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structXMP__PacketInfo.html#a66845c1d5f3f9f36a1543a7322bd7bd1">writeable</a></td></tr>
<tr class="memdesc:a66845c1d5f3f9f36a1543a7322bd7bd1"><td class="mdescLeft">&#160;</td><td class="mdescRight">True if there is a packet wrapper and the trailer says writeable by dumb packet scanners.  <a href="#a66845c1d5f3f9f36a1543a7322bd7bd1">More...</a><br /></td></tr>
<tr class="separator:a66845c1d5f3f9f36a1543a7322bd7bd1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6725d8ab8b4eedddaac950d2b1b00a7f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="XMP__Const_8h.html#a0cf68b6f47d136ed571a441a9e0d2248">XMP_Bool</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structXMP__PacketInfo.html#a6725d8ab8b4eedddaac950d2b1b00a7f">hasWrapper</a></td></tr>
<tr class="memdesc:a6725d8ab8b4eedddaac950d2b1b00a7f"><td class="mdescLeft">&#160;</td><td class="mdescRight">True if there is a packet wrapper, the "&lt;?xpacket...&gt;" XML processing instructions.  <a href="#a6725d8ab8b4eedddaac950d2b1b00a7f">More...</a><br /></td></tr>
<tr class="separator:a6725d8ab8b4eedddaac950d2b1b00a7f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a83ec12161a36451fef05d88cc754104e"><td class="memItemLeft" align="right" valign="top">XMP_Uns8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structXMP__PacketInfo.html#a83ec12161a36451fef05d88cc754104e">pad</a></td></tr>
<tr class="memdesc:a83ec12161a36451fef05d88cc754104e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Padding to make the struct's size be a multiple 4.  <a href="#a83ec12161a36451fef05d88cc754104e">More...</a><br /></td></tr>
<tr class="separator:a83ec12161a36451fef05d88cc754104e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>XMP packet description. </p>

<p>Definition at line <a class="el" href="XMP__Const_8h_source.html#l01068">1068</a> of file <a class="el" href="XMP__Const_8h_source.html">XMP_Const.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a2ae03a1b3d03fa9ebc829105037155a8"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">XMP_PacketInfo::XMP_PacketInfo </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Default constructor. </p>

<p>Definition at line <a class="el" href="XMP__Const_8h_source.html#l01088">1088</a> of file <a class="el" href="XMP__Const_8h_source.html">XMP_Const.h</a>.</p>
<div class="fragment"><div class="line"><a name="l01088"></a><span class="lineno"> 1088</span>&#160;                         : <a class="code" href="structXMP__PacketInfo.html#a20f65fcfd0f3658ab93ff441a9d61d2c">offset</a>(<a class="code" href="XMP__Const_8h.html#a6a9b77b60c63781a8776f10880856bf4">kXMPFiles_UnknownOffset</a>), <a class="code" href="structXMP__PacketInfo.html#af526c582b66e24553f2d4b11eb714a44">length</a>(<a class="code" href="XMP__Const_8h.html#ae0901aabcf619f17cff03f08e5ed3658">kXMPFiles_UnknownLength</a>),</div><div class="line"><a name="l01089"></a><span class="lineno"> 1089</span>&#160;                                           <a class="code" href="structXMP__PacketInfo.html#af4f99e6a5b36b05fdf4a519421875256">padSize</a>(0), <a class="code" href="structXMP__PacketInfo.html#a039ce6665fe8e08d922a46f266799f75">charForm</a>(0), <a class="code" href="structXMP__PacketInfo.html#a66845c1d5f3f9f36a1543a7322bd7bd1">writeable</a>(0), <a class="code" href="structXMP__PacketInfo.html#a6725d8ab8b4eedddaac950d2b1b00a7f">hasWrapper</a>(0), <a class="code" href="structXMP__PacketInfo.html#a83ec12161a36451fef05d88cc754104e">pad</a>(0) {};</div><div class="ttc" id="structXMP__PacketInfo_html_a66845c1d5f3f9f36a1543a7322bd7bd1"><div class="ttname"><a href="structXMP__PacketInfo.html#a66845c1d5f3f9f36a1543a7322bd7bd1">XMP_PacketInfo::writeable</a></div><div class="ttdeci">XMP_Bool writeable</div><div class="ttdoc">True if there is a packet wrapper and the trailer says writeable by dumb packet scanners. </div><div class="ttdef"><b>Definition:</b> <a href="XMP__Const_8h_source.html#l01080">XMP_Const.h:1080</a></div></div>
<div class="ttc" id="structXMP__PacketInfo_html_af526c582b66e24553f2d4b11eb714a44"><div class="ttname"><a href="structXMP__PacketInfo.html#af526c582b66e24553f2d4b11eb714a44">XMP_PacketInfo::length</a></div><div class="ttdeci">XMP_Int32 length</div><div class="ttdoc">Packet length in the file in bytes, -1 if unknown. </div><div class="ttdef"><b>Definition:</b> <a href="XMP__Const_8h_source.html#l01073">XMP_Const.h:1073</a></div></div>
<div class="ttc" id="structXMP__PacketInfo_html_a039ce6665fe8e08d922a46f266799f75"><div class="ttname"><a href="structXMP__PacketInfo.html#a039ce6665fe8e08d922a46f266799f75">XMP_PacketInfo::charForm</a></div><div class="ttdeci">XMP_Uns8 charForm</div><div class="ttdoc">Character format using the values kXMP_Char8Bit, kXMP_Char16BitBig, etc. </div><div class="ttdef"><b>Definition:</b> <a href="XMP__Const_8h_source.html#l01078">XMP_Const.h:1078</a></div></div>
<div class="ttc" id="structXMP__PacketInfo_html_a6725d8ab8b4eedddaac950d2b1b00a7f"><div class="ttname"><a href="structXMP__PacketInfo.html#a6725d8ab8b4eedddaac950d2b1b00a7f">XMP_PacketInfo::hasWrapper</a></div><div class="ttdeci">XMP_Bool hasWrapper</div><div class="ttdoc">True if there is a packet wrapper, the &quot;&lt;?xpacket...&gt;&quot; XML processing instructions. </div><div class="ttdef"><b>Definition:</b> <a href="XMP__Const_8h_source.html#l01082">XMP_Const.h:1082</a></div></div>
<div class="ttc" id="XMP__Const_8h_html_a6a9b77b60c63781a8776f10880856bf4"><div class="ttname"><a href="XMP__Const_8h.html#a6a9b77b60c63781a8776f10880856bf4">kXMPFiles_UnknownOffset</a></div><div class="ttdeci">#define kXMPFiles_UnknownOffset</div><div class="ttdoc">Constant for an unknown packet offset within a file. </div><div class="ttdef"><b>Definition:</b> <a href="XMP__Const_8h_source.html#l01061">XMP_Const.h:1061</a></div></div>
<div class="ttc" id="XMP__Const_8h_html_ae0901aabcf619f17cff03f08e5ed3658"><div class="ttname"><a href="XMP__Const_8h.html#ae0901aabcf619f17cff03f08e5ed3658">kXMPFiles_UnknownLength</a></div><div class="ttdeci">#define kXMPFiles_UnknownLength</div><div class="ttdoc">Constant for an unknown packet length within a file. </div><div class="ttdef"><b>Definition:</b> <a href="XMP__Const_8h_source.html#l01065">XMP_Const.h:1065</a></div></div>
<div class="ttc" id="structXMP__PacketInfo_html_af4f99e6a5b36b05fdf4a519421875256"><div class="ttname"><a href="structXMP__PacketInfo.html#af4f99e6a5b36b05fdf4a519421875256">XMP_PacketInfo::padSize</a></div><div class="ttdeci">XMP_Int32 padSize</div><div class="ttdoc">Packet padding size in bytes, zero if unknown. </div><div class="ttdef"><b>Definition:</b> <a href="XMP__Const_8h_source.html#l01075">XMP_Const.h:1075</a></div></div>
<div class="ttc" id="structXMP__PacketInfo_html_a20f65fcfd0f3658ab93ff441a9d61d2c"><div class="ttname"><a href="structXMP__PacketInfo.html#a20f65fcfd0f3658ab93ff441a9d61d2c">XMP_PacketInfo::offset</a></div><div class="ttdeci">XMP_Int64 offset</div><div class="ttdoc">Packet offset in the file in bytes, -1 if unknown. </div><div class="ttdef"><b>Definition:</b> <a href="XMP__Const_8h_source.html#l01071">XMP_Const.h:1071</a></div></div>
<div class="ttc" id="structXMP__PacketInfo_html_a83ec12161a36451fef05d88cc754104e"><div class="ttname"><a href="structXMP__PacketInfo.html#a83ec12161a36451fef05d88cc754104e">XMP_PacketInfo::pad</a></div><div class="ttdeci">XMP_Uns8 pad</div><div class="ttdoc">Padding to make the struct&amp;#39;s size be a multiple 4. </div><div class="ttdef"><b>Definition:</b> <a href="XMP__Const_8h_source.html#l01085">XMP_Const.h:1085</a></div></div>
</div><!-- fragment -->
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a039ce6665fe8e08d922a46f266799f75"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">XMP_Uns8 XMP_PacketInfo::charForm</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Character format using the values <code>kXMP_Char8Bit</code>, <code>kXMP_Char16BitBig</code>, etc. </p>

<p>Definition at line <a class="el" href="XMP__Const_8h_source.html#l01078">1078</a> of file <a class="el" href="XMP__Const_8h_source.html">XMP_Const.h</a>.</p>

</div>
</div>
<a class="anchor" id="a6725d8ab8b4eedddaac950d2b1b00a7f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="XMP__Const_8h.html#a0cf68b6f47d136ed571a441a9e0d2248">XMP_Bool</a> XMP_PacketInfo::hasWrapper</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>True if there is a packet wrapper, the "&lt;?xpacket...&gt;" XML processing instructions. </p>

<p>Definition at line <a class="el" href="XMP__Const_8h_source.html#l01082">1082</a> of file <a class="el" href="XMP__Const_8h_source.html">XMP_Const.h</a>.</p>

</div>
</div>
<a class="anchor" id="af526c582b66e24553f2d4b11eb714a44"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">XMP_Int32 XMP_PacketInfo::length</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Packet length in the file in bytes, -1 if unknown. </p>

<p>Definition at line <a class="el" href="XMP__Const_8h_source.html#l01073">1073</a> of file <a class="el" href="XMP__Const_8h_source.html">XMP_Const.h</a>.</p>

</div>
</div>
<a class="anchor" id="a20f65fcfd0f3658ab93ff441a9d61d2c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">XMP_Int64 XMP_PacketInfo::offset</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Packet offset in the file in bytes, -1 if unknown. </p>

<p>Definition at line <a class="el" href="XMP__Const_8h_source.html#l01071">1071</a> of file <a class="el" href="XMP__Const_8h_source.html">XMP_Const.h</a>.</p>

</div>
</div>
<a class="anchor" id="a83ec12161a36451fef05d88cc754104e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">XMP_Uns8 XMP_PacketInfo::pad</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Padding to make the struct's size be a multiple 4. </p>

<p>Definition at line <a class="el" href="XMP__Const_8h_source.html#l01085">1085</a> of file <a class="el" href="XMP__Const_8h_source.html">XMP_Const.h</a>.</p>

</div>
</div>
<a class="anchor" id="af4f99e6a5b36b05fdf4a519421875256"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">XMP_Int32 XMP_PacketInfo::padSize</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Packet padding size in bytes, zero if unknown. </p>

<p>Definition at line <a class="el" href="XMP__Const_8h_source.html#l01075">1075</a> of file <a class="el" href="XMP__Const_8h_source.html">XMP_Const.h</a>.</p>

</div>
</div>
<a class="anchor" id="a66845c1d5f3f9f36a1543a7322bd7bd1"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="XMP__Const_8h.html#a0cf68b6f47d136ed571a441a9e0d2248">XMP_Bool</a> XMP_PacketInfo::writeable</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>True if there is a packet wrapper and the trailer says writeable by dumb packet scanners. </p>

<p>Definition at line <a class="el" href="XMP__Const_8h_source.html#l01080">1080</a> of file <a class="el" href="XMP__Const_8h_source.html">XMP_Const.h</a>.</p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>C:/XMP/XMP-Toolkit-SDK-CC201607/XMP-Toolkit-SDK-CC201607/public/include/<a class="el" href="XMP__Const_8h_source.html">XMP_Const.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<hr size="1"><address style="text-align: right;"><small>
XMPToolkit documentation generated by&nbsp;<a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.11</small></address>
</body>
</html>