diff options
| author | Hubert Figuiere <hub@figuiere.net> | 2008-11-17 23:42:00 -0500 |
|---|---|---|
| committer | Hubert Figuiere <hub@figuiere.net> | 2008-11-17 23:42:00 -0500 |
| commit | 88af812fde414aca8f9add90bc800ea3d8e9a281 (patch) | |
| tree | 0403dd1897c0b287d4d710dd422827683c59dfcb /docs/API/structXMP__DateTime.html | |
| parent | 9d7d7c3caac05db240692ad7e9196fcb7f5a1ce5 (diff) | |
upgrade to XMP-SDK 4.4.2
Diffstat (limited to 'docs/API/structXMP__DateTime.html')
| -rw-r--r-- | docs/API/structXMP__DateTime.html | 145 |
1 files changed, 145 insertions, 0 deletions
diff --git a/docs/API/structXMP__DateTime.html b/docs/API/structXMP__DateTime.html new file mode 100644 index 0000000..bec9155 --- /dev/null +++ b/docs/API/structXMP__DateTime.html @@ -0,0 +1,145 @@ +<!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-Toolkit-SDK-4.4.2: XMP_DateTime Struct Reference</title> +<link href="xmp.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.5.6 --> +<script type="text/javascript"> +<!-- +function changeDisplayState (e){ + var num=this.id.replace(/[^[0-9]/g,''); + var button=this.firstChild; + var sectionDiv=document.getElementById('dynsection'+num); + if (sectionDiv.style.display=='none'||sectionDiv.style.display==''){ + sectionDiv.style.display='block'; + button.src='open.gif'; + }else{ + sectionDiv.style.display='none'; + button.src='closed.gif'; + } +} +function initDynSections(){ + var divs=document.getElementsByTagName('div'); + var sectionCounter=1; + for(var i=0;i<divs.length-1;i++){ + if(divs[i].className=='dynheader'&&divs[i+1].className=='dynsection'){ + var header=divs[i]; + var section=divs[i+1]; + var button=header.firstChild; + if (button!='IMG'){ + divs[i].insertBefore(document.createTextNode(' '),divs[i].firstChild); + button=document.createElement('img'); + divs[i].insertBefore(button,divs[i].firstChild); + } + header.style.cursor='pointer'; + header.onclick=changeDisplayState; + header.id='dynheader'+sectionCounter; + button.src='closed.gif'; + section.id='dynsection'+sectionCounter; + section.style.display='none'; + section.style.marginLeft='14px'; + sectionCounter++; + } + } +} +window.onload = initDynSections; +--> +</script> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</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 class="tabs"> + <ul> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>XMP_DateTime Struct Reference</h1><!-- doxytag: class="XMP_DateTime" -->The expanded type for a date and time. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="XMP__Const_8h-source.html">XMP_Const.h</a>></code> +<p> + +<p> +<a href="structXMP__DateTime-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2db713deacfd5a5cb2deea660ca2ccad"></a><!-- doxytag: member="XMP_DateTime::year" ref="2db713deacfd5a5cb2deea660ca2ccad" args="" --> +XMP_Int32 </td><td class="memItemRight" valign="bottom"><a class="el" href="structXMP__DateTime.html#2db713deacfd5a5cb2deea660ca2ccad">year</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">The year, can be negative. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b4b71c1a54879d7da1b4135e23d5446f"></a><!-- doxytag: member="XMP_DateTime::month" ref="b4b71c1a54879d7da1b4135e23d5446f" args="" --> +XMP_Int32 </td><td class="memItemRight" valign="bottom"><a class="el" href="structXMP__DateTime.html#b4b71c1a54879d7da1b4135e23d5446f">month</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">The month in the range 1..12. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="58496718277eea9dc5e3e19d80a69094"></a><!-- doxytag: member="XMP_DateTime::day" ref="58496718277eea9dc5e3e19d80a69094" args="" --> +XMP_Int32 </td><td class="memItemRight" valign="bottom"><a class="el" href="structXMP__DateTime.html#58496718277eea9dc5e3e19d80a69094">day</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">The day of the month in the range 1..31. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bc79cdca8cfa5df6583279e3f3e70e9f"></a><!-- doxytag: member="XMP_DateTime::hour" ref="bc79cdca8cfa5df6583279e3f3e70e9f" args="" --> +XMP_Int32 </td><td class="memItemRight" valign="bottom"><a class="el" href="structXMP__DateTime.html#bc79cdca8cfa5df6583279e3f3e70e9f">hour</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">The hour in the range 0..23. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e84965f3296a9c106d1f6c88aa6a7bdf"></a><!-- doxytag: member="XMP_DateTime::minute" ref="e84965f3296a9c106d1f6c88aa6a7bdf" args="" --> +XMP_Int32 </td><td class="memItemRight" valign="bottom"><a class="el" href="structXMP__DateTime.html#e84965f3296a9c106d1f6c88aa6a7bdf">minute</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">The minute in the range 0..59. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="675313c70a7e05b7ca50d21300b7d81b"></a><!-- doxytag: member="XMP_DateTime::second" ref="675313c70a7e05b7ca50d21300b7d81b" args="" --> +XMP_Int32 </td><td class="memItemRight" valign="bottom"><a class="el" href="structXMP__DateTime.html#675313c70a7e05b7ca50d21300b7d81b">second</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">The second in the range 0..59. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">XMP_Int32 </td><td class="memItemRight" valign="bottom"><a class="el" href="structXMP__DateTime.html#2786ad8875bd59f07b8dc2b1d09c6f96">tzSign</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6045133feeef41ac1f78c4664ab13db4"></a><!-- doxytag: member="XMP_DateTime::tzHour" ref="6045133feeef41ac1f78c4664ab13db4" args="" --> +XMP_Int32 </td><td class="memItemRight" valign="bottom"><a class="el" href="structXMP__DateTime.html#6045133feeef41ac1f78c4664ab13db4">tzHour</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">The time zone hour in the range 0..23. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="45baa70f30a3dc9f88819886cfb91aa1"></a><!-- doxytag: member="XMP_DateTime::tzMinute" ref="45baa70f30a3dc9f88819886cfb91aa1" args="" --> +XMP_Int32 </td><td class="memItemRight" valign="bottom"><a class="el" href="structXMP__DateTime.html#45baa70f30a3dc9f88819886cfb91aa1">tzMinute</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">The time zone minute in the range 0..59. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="190c2a19f01e90997ec2973aec37712c"></a><!-- doxytag: member="XMP_DateTime::nanoSecond" ref="190c2a19f01e90997ec2973aec37712c" args="" --> +XMP_Int32 </td><td class="memItemRight" valign="bottom"><a class="el" href="structXMP__DateTime.html#190c2a19f01e90997ec2973aec37712c">nanoSecond</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Nanoseconds within a second, often left as zero. <br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +The expanded type for a date and time. +<p> +Dates and time in the serialized XMP are ISO 8601 strings. The <code><a class="el" href="structXMP__DateTime.html" title="The expanded type for a date and time.">XMP_DateTime</a></code> struct allows easy conversion with other formats.<p> +All of the fields are 32 bit, even though most could be 8 bit. This avoids overflow when doing carries for arithmetic or normalization. All fields have signed values for the same reasons.<p> +Date-time values are occasionally used with only a date or only a time component. A date without a time has zeros in the <code><a class="el" href="structXMP__DateTime.html" title="The expanded type for a date and time.">XMP_DateTime</a></code> struct for all time fields. A time without a date has zeros for all date fields (year, month, and day).<p> +<code><a class="el" href="classTXMPUtils.html" title="API for access to the XMP Toolkit utility services.">TXMPUtils</a></code> provides utility functions for manipulating date-time values.<p> +<dl class="see" compact><dt><b>See also:</b></dt><dd><code><a class="el" href="classTXMPUtils.html#60d33e6ce30286028acca47b2b6e7a0b" title="ConvertToDate() converts a string to a date/time value.">TXMPUtils::ConvertToDate()</a></code>, <code><a class="el" href="classTXMPUtils.html#6146a522a3974b4088d6e8241e9cd223" title="ConvertFromDate() converts a date/time value to a string.">TXMPUtils::ConvertFromDate()</a></code>, <code><a class="el" href="classTXMPUtils.html#9fc7f1771032f59f9020aeda4f91991d" title="CompareDateTime() compares the order of two date/time values.">TXMPUtils::CompareDateTime()</a></code>, <code><a class="el" href="classTXMPUtils.html#61852aaba494c8fbad5a6c0c4caf21f5" title="ConvertToLocalTime() ensures that a time is local.">TXMPUtils::ConvertToLocalTime()</a></code>, <code><a class="el" href="classTXMPUtils.html#bbd4d691c83287ea2fc6b1e33e5858b8" title="ConvertToUTCTime() ensures that a time is UTC.">TXMPUtils::ConvertToUTCTime()</a></code>, <code><a class="el" href="classTXMPUtils.html#c83f0b963ea64d7eee0b481e15a8439c" title="CurrentDateTime() obtains the current date and time.">TXMPUtils::CurrentDateTime()</a></code>, <code><a class="el" href="classTXMPUtils.html#96bcc45febac55f6c49951815b7de2ef" title="SetTimeZone() sets the time zone in a date/time value to the local time zone.">TXMPUtils::SetTimeZone()</a></code> </dd></dl> +<hr><h2>Member Data Documentation</h2> +<a class="anchor" name="2786ad8875bd59f07b8dc2b1d09c6f96"></a><!-- doxytag: member="XMP_DateTime::tzSign" ref="2786ad8875bd59f07b8dc2b1d09c6f96" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">XMP_Int32 <a class="el" href="structXMP__DateTime.html#2786ad8875bd59f07b8dc2b1d09c6f96">XMP_DateTime::tzSign</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +The "sign" of the time zone, <code><a class="el" href="XMP__Const_8h.html#df764cbdea00d65edcd07bb9953ad2b73f41be55491204982acb39c9f6c7ad13" title="UTC time.">kXMP_TimeIsUTC</a></code> (0) means UTC, <code><a class="el" href="XMP__Const_8h.html#df764cbdea00d65edcd07bb9953ad2b7511551ce156d5fd96c26ad464b837801" title="Time zone is west of UTC.">kXMP_TimeWestOfUTC</a></code> (-1) is west, <code><a class="el" href="XMP__Const_8h.html#df764cbdea00d65edcd07bb9953ad2b768851b70cc1d2346fa21bc0b0ae6cfec" title="Time zone is east of UTC.">kXMP_TimeEastOfUTC</a></code> (+1) is east. +</div> +</div><p> +<hr>The documentation for this struct was generated from the following file:<ul> +<li><a class="el" href="XMP__Const_8h-source.html">XMP_Const.h</a></ul> +</div> +<hr size="1"><address style="text-align: right;"><small> +XMP-Toolkit-SDK-4.4.2 documentation generated by <a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.6</small></address> +</body> +</html> |