/usr/share/doc/libofx-doc/html/ofx__utilities_8hh.html is in libofx-doc 1:0.9.4-2.1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>LibOFX: ofx_utilities.hh File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">LibOFX</div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('ofx__utilities_8hh.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<h1>ofx_utilities.hh File Reference</h1> </div>
</div>
<div class="contents">
<p>Various simple functions for type conversion & al.
<a href="#_details">More...</a></p>
<p><a href="ofx__utilities_8hh_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a39ffcaaff3de66030e3e59c2e3e98f8e"></a><!-- doxytag: member="ofx_utilities.hh::operator<<" ref="a39ffcaaff3de66030e3e59c2e3e98f8e" args="(ostream &os, SGMLApplication::CharString s)" -->
ostream & </td><td class="memItemRight" valign="bottom"><a class="el" href="ofx__utilities_8hh.html#a39ffcaaff3de66030e3e59c2e3e98f8e">operator<<</a> (ostream &os, SGMLApplication::CharString s)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convert OpenSP CharString to a C++ stream. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2fd46abc036e918fce7b04d9200b3e75"></a><!-- doxytag: member="ofx_utilities.hh::CharStringtowchar_t" ref="a2fd46abc036e918fce7b04d9200b3e75" args="(SGMLApplication::CharString source, wchar_t *dest)" -->
wchar_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="ofx__utilities_8hh.html#a2fd46abc036e918fce7b04d9200b3e75">CharStringtowchar_t</a> (SGMLApplication::CharString source, wchar_t *dest)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convert OpenSP CharString and put it in the C wchar_t string provided. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="ofx__utilities_8hh.html#ae7575392f9f9c464ede10057dec0e8e4">CharStringtostring</a> (const SGMLApplication::CharString source, string &dest)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convert OpenSP CharString to a C++ STL string. <a href="#ae7575392f9f9c464ede10057dec0e8e4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a50b88c84b759d3058397336e7ea42c32"></a><!-- doxytag: member="ofx_utilities.hh::AppendCharStringtostring" ref="a50b88c84b759d3058397336e7ea42c32" args="(const SGMLApplication::CharString source, string &dest)" -->
string </td><td class="memItemRight" valign="bottom"><a class="el" href="ofx__utilities_8hh.html#a50b88c84b759d3058397336e7ea42c32">AppendCharStringtostring</a> (const SGMLApplication::CharString source, string &dest)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Append an OpenSP CharString to an existing C++ STL string. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">time_t </td><td class="memItemRight" valign="bottom"><a class="el" href="ofx__utilities_8hh.html#a5fdbbc08f8d80a534f8db03d25316d7a">ofxdate_to_time_t</a> (const string ofxdate)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convert a C++ string containing a time in OFX format to a C time_t. <a href="#a5fdbbc08f8d80a534f8db03d25316d7a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="ofx__utilities_8hh.html#abfca5b423e5d7b194eb53c53f706f6ba">ofxamount_to_double</a> (const string ofxamount)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convert OFX amount of money to double float. <a href="#abfca5b423e5d7b194eb53c53f706f6ba"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="ofx__utilities_8hh.html#a34933785dd934134973847e58a700733">strip_whitespace</a> (const string para_string)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sanitize a string coming from OpenSP. <a href="#a34933785dd934134973847e58a700733"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa0e945c824a3012017b4babd721d9f38"></a><!-- doxytag: member="ofx_utilities.hh::mkTempFileName" ref="aa0e945c824a3012017b4babd721d9f38" args="(const char *tmpl, char *buffer, unsigned int size)" -->
int </td><td class="memItemRight" valign="bottom"><b>mkTempFileName</b> (const char *tmpl, char *buffer, unsigned int size)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Various simple functions for type conversion & al. </p>
<p>Definition in file <a class="el" href="ofx__utilities_8hh_source.html">ofx_utilities.hh</a>.</p>
</div><hr/><h2>Function Documentation</h2>
<a class="anchor" id="ae7575392f9f9c464ede10057dec0e8e4"></a><!-- doxytag: member="ofx_utilities.hh::CharStringtostring" ref="ae7575392f9f9c464ede10057dec0e8e4" args="(const SGMLApplication::CharString source, string &dest)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string CharStringtostring </td>
<td>(</td>
<td class="paramtype">const SGMLApplication::CharString </td>
<td class="paramname"><em>source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">string & </td>
<td class="paramname"><em>dest</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Convert OpenSP CharString to a C++ STL string. </p>
<p>Convert an OpenSP CharString directly to a C++ stream, to enable the use of cout directly for debugging. </p>
<p>Definition at line <a class="el" href="ofx__utilities_8cpp_source.html#l00070">70</a> of file <a class="el" href="ofx__utilities_8cpp_source.html">ofx_utilities.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="abfca5b423e5d7b194eb53c53f706f6ba"></a><!-- doxytag: member="ofx_utilities.hh::ofxamount_to_double" ref="abfca5b423e5d7b194eb53c53f706f6ba" args="(const string ofxamount)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double ofxamount_to_double </td>
<td>(</td>
<td class="paramtype">const string </td>
<td class="paramname"><em>ofxamount</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Convert OFX amount of money to double float. </p>
<p>Convert a C++ string containing an amount of money as specified by the OFX standard and convert it to a double float. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>The ofx number format is the following: "." or "," as decimal separator, NO thousands separator. </dd></dl>
<p>Definition at line <a class="el" href="ofx__utilities_8cpp_source.html#l00204">204</a> of file <a class="el" href="ofx__utilities_8cpp_source.html">ofx_utilities.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a5fdbbc08f8d80a534f8db03d25316d7a"></a><!-- doxytag: member="ofx_utilities.hh::ofxdate_to_time_t" ref="a5fdbbc08f8d80a534f8db03d25316d7a" args="(const string ofxdate)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">time_t ofxdate_to_time_t </td>
<td>(</td>
<td class="paramtype">const string </td>
<td class="paramname"><em>ofxdate</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Convert a C++ string containing a time in OFX format to a C time_t. </p>
<p>Converts a date from the YYYYMMDDHHMMSS.XXX[gmt offset:tz name] OFX format (see OFX 2.01 spec p.66) to a C time_t. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">ofxdate</td><td>date from the YYYYMMDDHHMMSS.XXX[gmt offset:tz name] OFX format </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>C time_t in the local time zone </dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd><ul>
<li>The library always returns the time in the systems local time </li>
<li>OFX defines the date up to the millisecond. The library ignores those milliseconds, since ANSI C does not handle such precision cleanly. The date provided by LibOFX is precise to the second, assuming that information this precise was provided in the ofx file. So you wont know the millisecond you were ruined...</li>
</ul>
</dd>
<dd>
DEVIATION FROM THE SPECS : The OFX specifications (both version 1.6 and 2.02) state that a client should assume that if the server returns a date without � specific time, we assume it means 0h00 GMT. As such, when we apply the local timezone and for example you are in the EST timezone, we will remove 5h, and the transaction will have occurred on the prior day! This is probably not what the bank intended (and will lead to systematic errors), but the spec is quite explicit in this respect (Ref: OFX 2.01 spec pp. 66-68)<br/>
<br/>
To solve this problem (since usually a time error is relatively unimportant, but date error is), and to avoid problems in Australia caused by the behaviour in libofx up to 0.6.4, it was decided starting with 0.6.5 to use the following behavior:<br/>
<br/>
-No specific time is given in the file (date only): Considering that most banks seem to be sending dates in this format represented as local time (not compliant with the specs), the transaction is assumed to have occurred 11h59 (just before noon) LOCAL TIME. This way, we should never change the date, since you'd have to travel in a timezone at least 11 hours backwards or 13 hours forward from your own to introduce mistakes. However, if you are in timezone +13 or +14, and your bank meant the data to be interpreted by the spec, you will get the wrong date. We hope that banks in those timezone will either represent in local time like most, or specify the timezone properly.<br/>
<br/>
-No timezone is specified, but exact time is, the same behavior is mostly used, as many banks just append zeros instead of using the short notation. However, the time specified is used, even if 0 (midnight).<br/>
<br/>
-When a timezone is specified, it is always used to properly convert in local time, following the spec. </dd></dl>
<p>Definition at line <a class="el" href="ofx__utilities_8cpp_source.html#l00108">108</a> of file <a class="el" href="ofx__utilities_8cpp_source.html">ofx_utilities.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a34933785dd934134973847e58a700733"></a><!-- doxytag: member="ofx_utilities.hh::strip_whitespace" ref="a34933785dd934134973847e58a700733" args="(const string para_string)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string strip_whitespace </td>
<td>(</td>
<td class="paramtype">const string </td>
<td class="paramname"><em>para_string</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sanitize a string coming from OpenSP. </p>
<p>Many weird caracters can be present inside a SGML element, as a result on the transfer protocol, or for any reason. This function greatly enhances the reliability of the library by zapping those gremlins (backspace,formfeed,newline,carriage return, horizontal and vertical tabs) as well as removing whitespace at the begining and end of the string. Otherwise, many problems will occur during stringmatching. </p>
<p>Definition at line <a class="el" href="ofx__utilities_8cpp_source.html#l00227">227</a> of file <a class="el" href="ofx__utilities_8cpp_source.html">ofx_utilities.cpp</a>.</p>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="ofx__utilities_8hh.html">ofx_utilities.hh</a> </li>
<li class="footer">Generated on Mon Apr 18 2011 18:09:44 for LibOFX by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </li>
</ul>
</div>
</body>
</html>
|