-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #114 from datalogics/develop
Add C++ api reference documentation for APDFL version 18.0.4+P2w
- Loading branch information
Showing
4,021 changed files
with
914,158 additions
and
8 deletions.
The diff you're trying to view is too large. We only load the first 3000 changed files.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
4,540 changes: 4,540 additions & 0 deletions
4,540
apdfl18/CPlusPlus/APDFL18.0.4PlusP2w/acrocolor_acrocolor.html
Large diffs are not rendered by default.
Oops, something went wrong.
316 changes: 316 additions & 0 deletions
316
apdfl18/CPlusPlus/APDFL18.0.4PlusP2w/aslayer_ASAtom.html
Large diffs are not rendered by default.
Oops, something went wrong.
2,683 changes: 2,683 additions & 0 deletions
2,683
apdfl18/CPlusPlus/APDFL18.0.4PlusP2w/aslayer_ASCab.html
Large diffs are not rendered by default.
Oops, something went wrong.
201 changes: 201 additions & 0 deletions
201
apdfl18/CPlusPlus/APDFL18.0.4PlusP2w/aslayer_ASCalendarTimeSpan.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,201 @@ | ||
|
|
||
| <!DOCTYPE html> | ||
| <html lang="en-US"> | ||
| <head> | ||
| <link rel="stylesheet" href="resources/css/pageStyles.css"> | ||
| <link rel="icon" type="image/x-icon" href="resources/img/DLicon.png"> | ||
| <meta charset="UTF-8"> | ||
| <title> | ||
| Acro Support Layer: ASCalendarTimeSpan | ||
| </title> | ||
| </head> | ||
| <script async src="https://www.googletagmanager.com/gtag/js?id=G-L4MQFNK7VK"></script> | ||
| <script> | ||
| window.dataLayer = window.dataLayer || []; | ||
| function gtag(){dataLayer.push(arguments);} | ||
| gtag('js', new Date()); gtag('config', 'G-L4MQFNK7VK'); | ||
| </script> | ||
| <body><div> | ||
| <a href="index.html"><img src="resources/img/DL-Full-Logo-LightBG-Blue.svg" alt="DL Logo" style="height: 66px; border-bottom: 1px solid black; padding-bottom: 5px; width: auto; background: #ffffff; position: fixed; z-index: 1; top: 0px; left: 0px;"></a> | ||
| </div> | ||
| <div class="verSelect" style="position: fixed; z-index: 2; top: 41px; left: 0px;"><iframe id="ver" src="../ver.html" style=" height: 45px; border-width: 0px;"></iframe></div> | ||
| <div class="fullTOC"><iframe src="TOC.html"></iframe></div> | ||
| <div class="objDoc"><nav><ul> | ||
| <h5>Acro Support Layer: ASCalendarTimeSpan</h5> | ||
| <li><a href="#Structures">Structures</a></li> | ||
| <li><a href="#Functions">Functions</a></li> | ||
| </ul></nav> | ||
| <section id="Structures"> | ||
| <header><h2>ASCalendarTimeSpan Structures</h2></header> | ||
| <nav><dl> | ||
| <dt><a href="#_t_ASCalendarTimeSpan">_t_ASCalendarTimeSpan</a></dt><dd> - Represents a calendar time span used to calculate ambiguous time spans such as 1 year and 3 months.</dd> | ||
| </dl></nav> | ||
| <section><div class="infoRow"><h3 id="_t_ASCalendarTimeSpan"><strong><span style="color:grey;">_t_ASCalendarTimeSpan</span></strong></h3> | ||
|
|
||
| <div class="headerRef"><strong>Header:</strong> ASExpT.h:3860</div> | ||
| </div> | ||
|
|
||
| <div><H4><strong>Description</strong></H4> | ||
|
|
||
| <div>Represents a calendar time span used to calculate ambiguous time spans such as 1 year and 3 months. A calendar time span cannot be negative. </div> | ||
| </div> | ||
|
|
||
| <H4><strong>Syntax</strong></H4> | ||
|
|
||
| <div><table><tr><td><code><code>struct _t_ASCalendarTimeSpan {</code> </code> | ||
| </td><td><div></div> | ||
| </td></tr> | ||
| <tr><td><div class="structMember"><a href="aslayer_General.html#ASUns32" title=" 4-byte unsigned long numeric value."><code>ASUns32</code></a> <code>Year</code><code>;</code> </div> | ||
| </td><td><div>Year. </div> | ||
| </td></tr> | ||
| <tr><td><div class="structMember"><a href="aslayer_General.html#ASUns32" title=" 4-byte unsigned long numeric value."><code>ASUns32</code></a> <code>Month</code><code>;</code> </div> | ||
| </td><td><div>Month. </div> | ||
| </td></tr> | ||
| <tr><td><div class="structMember"><a href="aslayer_General.html#ASUns32" title=" 4-byte unsigned long numeric value."><code>ASUns32</code></a> <code>Day</code><code>;</code> </div> | ||
| </td><td><div>Day. </div> | ||
| </td></tr> | ||
| <tr><td><div class="structMember"><a href="aslayer_General.html#ASUns32" title=" 4-byte unsigned long numeric value."><code>ASUns32</code></a> <code>Hour</code><code>;</code> </div> | ||
| </td><td><div>Hour. </div> | ||
| </td></tr> | ||
| <tr><td><div class="structMember"><a href="aslayer_General.html#ASUns32" title=" 4-byte unsigned long numeric value."><code>ASUns32</code></a> <code>Minute</code><code>;</code> </div> | ||
| </td><td><div>Minute. </div> | ||
| </td></tr> | ||
| <tr><td><div class="structMember"><a href="aslayer_General.html#ASUns32" title=" 4-byte unsigned long numeric value."><code>ASUns32</code></a> <code>Second</code><code>;</code> </div> | ||
| </td><td><div>Second. </div> | ||
| </td></tr> | ||
| <tr><td><code id="ASCalendarTimeSpanRec"><code>}</code> <a href="aslayer_ASCalendarTimeSpan.html#_t_ASCalendarTimeSpan" title=" Represents a calendar time span used to calculate ambiguous time spans such as 1 year and 3 months."><code>ASCalendarTimeSpanRec</code></a><code>,</code> <code>*</code><a href="aslayer_ASCalendarTimeSpan.html#_t_ASCalendarTimeSpan" title=" Represents a calendar time span used to calculate ambiguous time spans such as 1 year and 3 months."><code>ASCalendarTimeSpan</code></a><code>;</code> </code> | ||
| </td><td><div></div> | ||
| </td></tr></table> | ||
| </div> | ||
|
|
||
| <H4><strong>Used By</strong></H4> | ||
|
|
||
| <nav><table><tr><td><a href="aslayer_ASCalendarTimeSpan.html#ASCalendarTimeSpanAddWithBase" title=" Adds two calendar time spans, storing the result in another calendar time span object."><code>ASCalendarTimeSpanAddWithBase</code></a></td><td><a href="aslayer_ASCalendarTimeSpan.html#ASCalendarTimeSpanCompare" title=" Compares two calendar time spans with respect to a base date."><code>ASCalendarTimeSpanCompare</code></a></td></tr> | ||
| <tr><td><a href="aslayer_ASCalendarTimeSpan.html#ASCalendarTimeSpanDiff" title=" Calculates the difference between calendar time span objects and stores the result in the provided ASCalendarTimeSpan object."><code>ASCalendarTimeSpanDiff</code></a></td><td><a href="aslayer_ASDate.html#ASDateAddCalendarTimeSpan" title=" Adds a calendar time span to a date."><code>ASDateAddCalendarTimeSpan</code></a></td></tr> | ||
| <tr><td><a href="aslayer_ASDate.html#ASDateCalendarDiff" title=" Calculates the difference between two ASDate objects and stores the result in the provided ASCalendarTimeSpan object."><code>ASDateCalendarDiff</code></a></td><td><a href="aslayer_ASDate.html#ASDateSubtractCalendarTimeSpan" title=" Subtracts a calendar time span from a date."><code>ASDateSubtractCalendarTimeSpan</code></a></td></tr></table> | ||
| </nav> | ||
| </section> | ||
| </section> | ||
| <section id="Functions"> | ||
| <header><h2>ASCalendarTimeSpan Functions</h2></header> | ||
| <nav><dl> | ||
| <dt><a href="#ASCalendarTimeSpanAddWithBase">ASCalendarTimeSpanAddWithBase</a></dt><dd> - Adds two calendar time spans, storing the result in another calendar time span object.</dd> | ||
| <dt><a href="#ASCalendarTimeSpanCompare">ASCalendarTimeSpanCompare</a></dt><dd> - Compares two calendar time spans with respect to a base date.</dd> | ||
| <dt><a href="#ASCalendarTimeSpanDiff">ASCalendarTimeSpanDiff</a></dt><dd> - Calculates the difference between calendar time span objects and stores the result in the provided ASCalendarTimeSpan object.</dd> | ||
| </dl></nav> | ||
| <section><div class="infoRow"><h3 id="ASCalendarTimeSpanAddWithBase"><strong><span style="color:grey;">ASCalendarTimeSpanAddWithBase</span></strong></h3> | ||
|
|
||
| <div class="headerRef"><strong>Header:</strong> ASExtraProcs.h:1874</div> | ||
| </div> | ||
|
|
||
| <div><div><H4><strong>Description</strong></H4> | ||
|
|
||
| <div>Adds two calendar time spans, storing the result in another calendar time span object. Because the values in a calendar time span are not absolute (for example, a leap year has a different number of days), they are resolved with respect to the base date before the addition is done. The result is broken down into years, months, and so on, in the highest denomination possible. For example, a difference of 13 months is reported as 1 year and 1 month. </div> | ||
| </div> | ||
|
|
||
| <div class="relatedMethods"><H4><strong>Related Methods</strong></H4> | ||
|
|
||
| <a href="aslayer_ASCalendarTimeSpan.html#ASCalendarTimeSpanCompare" title=" Compares two calendar time spans with respect to a base date."><code>ASCalendarTimeSpanCompare</code></a> | ||
| <a href="aslayer_ASDate.html#ASDateAddCalendarTimeSpan" title=" Adds a calendar time span to a date."><code>ASDateAddCalendarTimeSpan</code></a> | ||
| <a href="aslayer_ASTimeSpan.html#ASTimeSpanAdd" title=" Adds two time spans, storing the result (an exact number of seconds) in another time span object."><code>ASTimeSpanAdd</code></a></div> | ||
| </div> | ||
|
|
||
| <H4><strong>Syntax</strong></H4> | ||
|
|
||
| <code><code>void</code> <code>ASCalendarTimeSpanAddWithBase(</code><code>const</code> <a href="aslayer_ASCalendarTimeSpan.html#_t_ASCalendarTimeSpan" title=" Represents a calendar time span used to calculate ambiguous time spans such as 1 year and 3 months."><code>ASCalendarTimeSpan</code></a> <code>timeSpan1</code><code>,</code> <code>const</code> <a href="aslayer_ASCalendarTimeSpan.html#_t_ASCalendarTimeSpan" title=" Represents a calendar time span used to calculate ambiguous time spans such as 1 year and 3 months."><code>ASCalendarTimeSpan</code></a> <code>timeSpan2</code><code>,</code> <code>const</code> <a href="aslayer_ASDate.html#ASDate" title=" An opaque object holding information for a particular date and time."><code>ASDate</code></a> <code>baseDate</code><code>,</code> <a href="aslayer_ASCalendarTimeSpan.html#_t_ASCalendarTimeSpan" title=" Represents a calendar time span used to calculate ambiguous time spans such as 1 year and 3 months."><code>ASCalendarTimeSpan</code></a> <code>result</code><code>);</code> </code> | ||
|
|
||
| <H4><strong>Parameters</strong></H4> | ||
|
|
||
| <Table class="paramsTable"><tr><td><div><code>timeSpan1</code></div> | ||
| </td><td><div>The first calendar time span to add. </div> | ||
| </td></tr> | ||
| <tr><td><div><code>timeSpan2</code></div> | ||
| </td><td><div>The calendar time span to add. </div> | ||
| </td></tr> | ||
| <tr><td><div><code>baseDate</code></div> | ||
| </td><td><div>The base date, or <a href="aslayer_General.html#NULL"><code>NULL</code></a> to use Jan 1 1970 00:00:00, the epoch time. </div> | ||
| </td></tr> | ||
| <tr><td><div><code>result</code></div> | ||
| </td><td><div>The calendar time span structure in which to store the result. </div> | ||
| </td></tr></Table> | ||
| </section> | ||
| <section><div class="infoRow"><h3 id="ASCalendarTimeSpanCompare"><strong><span style="color:grey;">ASCalendarTimeSpanCompare</span></strong></h3> | ||
|
|
||
| <div class="headerRef"><strong>Header:</strong> ASExtraProcs.h:1839</div> | ||
| </div> | ||
|
|
||
| <div><div><H4><strong>Description</strong></H4> | ||
|
|
||
| <div>Compares two calendar time spans with respect to a base date. Because the values in a calendar time span are not absolute (for example, a leap year has a different number of days), they are resolved with respect to the base date before the comparison is made. </div> | ||
| </div> | ||
|
|
||
| <div class="relatedMethods"><H4><strong>Related Methods</strong></H4> | ||
|
|
||
| <a href="aslayer_ASDate.html#ASDateCompare" title=" Tests whether one date is earlier or later than another."><code>ASDateCompare</code></a> | ||
| <a href="aslayer_ASTimeSpan.html#ASTimeSpanCompare" title=" Compares two time spans to determine if they are equal or if one represents fewer seconds than the other."><code>ASTimeSpanCompare</code></a></div> | ||
| </div> | ||
|
|
||
| <H4><strong>Syntax</strong></H4> | ||
|
|
||
| <code><a href="aslayer_General.html#ASInt32" title=" 4-byte signed long numeric value."><code>ASInt32</code></a> <code>ASCalendarTimeSpanCompare(</code><code>const</code> <a href="aslayer_ASCalendarTimeSpan.html#_t_ASCalendarTimeSpan" title=" Represents a calendar time span used to calculate ambiguous time spans such as 1 year and 3 months."><code>ASCalendarTimeSpan</code></a> <code>timeSpan1</code><code>,</code> <code>const</code> <a href="aslayer_ASCalendarTimeSpan.html#_t_ASCalendarTimeSpan" title=" Represents a calendar time span used to calculate ambiguous time spans such as 1 year and 3 months."><code>ASCalendarTimeSpan</code></a> <code>timeSpan2</code><code>,</code> <code>const</code> <a href="aslayer_ASDate.html#ASDate" title=" An opaque object holding information for a particular date and time."><code>ASDate</code></a> <code>baseDate</code><code>);</code> </code> | ||
|
|
||
| <H4><strong>Parameters</strong></H4> | ||
|
|
||
| <Table class="paramsTable"><tr><td><div><code>timeSpan1</code></div> | ||
| </td><td><div>The first calendar time span. </div> | ||
| </td></tr> | ||
| <tr><td><div><code>timeSpan2</code></div> | ||
| </td><td><div>The second calendar time span. </div> | ||
| </td></tr> | ||
| <tr><td><div><code>baseDate</code></div> | ||
| </td><td><div>The base date, or <a href="aslayer_General.html#NULL"><code>NULL</code></a> to use Jan 1 1970 00:00:00, the epoch time. </div> | ||
| </td></tr></Table> | ||
|
|
||
| <H4><strong>Returns</strong></H4> | ||
|
|
||
| <div><code>1</code> if <code>timeSpan1</code> <code>></code> <code>timeSpan2</code>, <code>0</code> if they are equal, and<code>-1</code> if <code>timeSpan1</code> <code><</code> <code>timeSpan2</code>. </div> | ||
| </section> | ||
| <section><div class="infoRow"><h3 id="ASCalendarTimeSpanDiff"><strong><span style="color:grey;">ASCalendarTimeSpanDiff</span></strong></h3> | ||
|
|
||
| <div class="headerRef"><strong>Header:</strong> ASExtraProcs.h:1910</div> | ||
| </div> | ||
|
|
||
| <div><div><H4><strong>Description</strong></H4> | ||
|
|
||
| <div>Calculates the difference between calendar time span objects and stores the result in the provided <a href="aslayer_ASCalendarTimeSpan.html#_t_ASCalendarTimeSpan" title=" Represents a calendar time span used to calculate ambiguous time spans such as 1 year and 3 months.">ASCalendarTimeSpan</a> object. If <code>timeSpan2</code> is less than <code>timeSpan1</code>, the result is negative. Because the values in a calendar time span are not absolute (for example, a leap year has a different number of days), they are resolved with respect to the base date before the addition is done. The result is broken down into years, months, and so on, in the highest denomination possible. For example, a difference of 13 months is reported as 1 year and 1 month. </div> | ||
| </div> | ||
|
|
||
| <div class="relatedMethods"><H4><strong>Related Methods</strong></H4> | ||
|
|
||
| <a href="aslayer_ASDate.html#ASDateCalendarDiff" title=" Calculates the difference between two ASDate objects and stores the result in the provided ASCalendarTimeSpan object."><code>ASDateCalendarDiff</code></a> | ||
| <a href="aslayer_ASTimeSpan.html#ASTimeSpanDiff" title=" Calculates the exact difference in seconds between time span objects and stores the result in the provided ASTimeSpan object."><code>ASTimeSpanDiff</code></a></div> | ||
| </div> | ||
|
|
||
| <H4><strong>Syntax</strong></H4> | ||
|
|
||
| <code><code>void</code> <code>ASCalendarTimeSpanDiff(</code><code>const</code> <a href="aslayer_ASCalendarTimeSpan.html#_t_ASCalendarTimeSpan" title=" Represents a calendar time span used to calculate ambiguous time spans such as 1 year and 3 months."><code>ASCalendarTimeSpan</code></a> <code>timeSpan1</code><code>,</code> <code>const</code> <a href="aslayer_ASCalendarTimeSpan.html#_t_ASCalendarTimeSpan" title=" Represents a calendar time span used to calculate ambiguous time spans such as 1 year and 3 months."><code>ASCalendarTimeSpan</code></a> <code>timeSpan2</code><code>,</code> <code>const</code> <a href="aslayer_ASDate.html#ASDate" title=" An opaque object holding information for a particular date and time."><code>ASDate</code></a> <code>baseDate</code><code>,</code> <a href="aslayer_ASCalendarTimeSpan.html#_t_ASCalendarTimeSpan" title=" Represents a calendar time span used to calculate ambiguous time spans such as 1 year and 3 months."><code>ASCalendarTimeSpan</code></a> <code>result</code><code>);</code> </code> | ||
|
|
||
| <H4><strong>Parameters</strong></H4> | ||
|
|
||
| <Table class="paramsTable"><tr><td><div><code>timeSpan1</code></div> | ||
| </td><td><div>The first calendar time span. </div> | ||
| </td></tr> | ||
| <tr><td><div><code>timeSpan2</code></div> | ||
| </td><td><div>The second calendar time span. </div> | ||
| </td></tr> | ||
| <tr><td><div><code>baseDate</code></div> | ||
| </td><td><div>The base date, or <a href="aslayer_General.html#NULL"><code>NULL</code></a> to use Jan 1 1970 00:00:00, the epoch time. </div> | ||
| </td></tr> | ||
| <tr><td><div><code>result</code></div> | ||
| </td><td><div>The calendar time span object in which to store the difference. </div> | ||
| </td></tr></Table> | ||
| </section> | ||
| </section> | ||
|
|
||
| </div> | ||
| </body> | ||
| <script> | ||
| currVer = window.location.pathname.split("/").slice(-2)[0] | ||
| document.getElementById("ver").src += "?=" + currVer | ||
| </script> | ||
| </html> |
Oops, something went wrong.