libofx-doc 1:0.9.12-1 / usr / share / doc / libofx-doc / html / structOfxSecurityData.html

This file is indexed.

/usr/share/doc/libofx-doc/html/structOfxSecurityData.html is in libofx-doc 1:0.9.12-1.

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
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>LibOFX: OfxSecurityData Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">LibOFX
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></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('structOfxSecurityData.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<div class="title">OfxSecurityData Struct Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>An abstraction of a security, such as a stock, mutual fund, etc.  
 <a href="structOfxSecurityData.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">OFX mandatory elements</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p>The OFX spec defines the following elements as mandatory. The associated variables should all contain valid data but you should not trust the servers. Check if the associated *_valid is true before using them. </p>
</div></td></tr>
<tr class="memitem:a074c29532d07fe5dc782f50a5ce0bce5"><td class="memItemLeft" align="right" valign="top">char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOfxSecurityData.html#a074c29532d07fe5dc782f50a5ce0bce5">unique_id</a> [OFX_UNIQUE_ID_LENGTH]</td></tr>
<tr class="separator:a074c29532d07fe5dc782f50a5ce0bce5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa7ecd355d7f19287032fe54395a28a62"><td class="memItemLeft" align="right" valign="top"><a id="aa7ecd355d7f19287032fe54395a28a62"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>unique_id_valid</b></td></tr>
<tr class="separator:aa7ecd355d7f19287032fe54395a28a62"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaa852fc186b988a50d48b7b72b35d97b"><td class="memItemLeft" align="right" valign="top">char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOfxSecurityData.html#aaa852fc186b988a50d48b7b72b35d97b">unique_id_type</a> [OFX_UNIQUE_ID_TYPE_LENGTH]</td></tr>
<tr class="separator:aaa852fc186b988a50d48b7b72b35d97b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4dd2110777af7a80bdedc2775afa4415"><td class="memItemLeft" align="right" valign="top"><a id="a4dd2110777af7a80bdedc2775afa4415"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>unique_id_type_valid</b></td></tr>
<tr class="separator:a4dd2110777af7a80bdedc2775afa4415"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6040f74d90d7e379069668e9377f05a7"><td class="memItemLeft" align="right" valign="top">char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOfxSecurityData.html#a6040f74d90d7e379069668e9377f05a7">secname</a> [OFX_SECNAME_LENGTH]</td></tr>
<tr class="separator:a6040f74d90d7e379069668e9377f05a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a52b1cc129ff42506f38d361a91aa6b3b"><td class="memItemLeft" align="right" valign="top"><a id="a52b1cc129ff42506f38d361a91aa6b3b"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>secname_valid</b></td></tr>
<tr class="separator:a52b1cc129ff42506f38d361a91aa6b3b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">OFX optional elements</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p>The OFX spec defines the following elements as optional. If the associated *_valid is true, the corresponding element is present and the associated variable contains valid data. </p>
</div></td></tr>
<tr class="memitem:afe1b8fb89161e47a1252bf6e6b13d624"><td class="memItemLeft" align="right" valign="top">char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOfxSecurityData.html#afe1b8fb89161e47a1252bf6e6b13d624">ticker</a> [OFX_TICKER_LENGTH]</td></tr>
<tr class="separator:afe1b8fb89161e47a1252bf6e6b13d624"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a70920a7c4c7db99ab3fdff9a69be1dcc"><td class="memItemLeft" align="right" valign="top"><a id="a70920a7c4c7db99ab3fdff9a69be1dcc"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>ticker_valid</b></td></tr>
<tr class="separator:a70920a7c4c7db99ab3fdff9a69be1dcc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab7e970b0d2efb4afd77e5140f6377eea"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOfxSecurityData.html#ab7e970b0d2efb4afd77e5140f6377eea">unitprice</a></td></tr>
<tr class="separator:ab7e970b0d2efb4afd77e5140f6377eea"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0393e16cd2a2e36ab3c08274eb3d2e4b"><td class="memItemLeft" align="right" valign="top"><a id="a0393e16cd2a2e36ab3c08274eb3d2e4b"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>unitprice_valid</b></td></tr>
<tr class="separator:a0393e16cd2a2e36ab3c08274eb3d2e4b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a39f70a97d1390f293a9726a014ed5736"><td class="memItemLeft" align="right" valign="top">time_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOfxSecurityData.html#a39f70a97d1390f293a9726a014ed5736">date_unitprice</a></td></tr>
<tr class="separator:a39f70a97d1390f293a9726a014ed5736"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad4cd155f29e20ebc3e85de05f6178510"><td class="memItemLeft" align="right" valign="top"><a id="ad4cd155f29e20ebc3e85de05f6178510"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>date_unitprice_valid</b></td></tr>
<tr class="separator:ad4cd155f29e20ebc3e85de05f6178510"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a57f148fe703f73ea110e24c5470a9242"><td class="memItemLeft" align="right" valign="top">char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOfxSecurityData.html#a57f148fe703f73ea110e24c5470a9242">currency</a> [OFX_CURRENCY_LENGTH]</td></tr>
<tr class="separator:a57f148fe703f73ea110e24c5470a9242"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2d16df55fa63534c4d4d7a5c804e9fb6"><td class="memItemLeft" align="right" valign="top"><a id="a2d16df55fa63534c4d4d7a5c804e9fb6"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>currency_valid</b></td></tr>
<tr class="separator:a2d16df55fa63534c4d4d7a5c804e9fb6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac29fe2ecb97aefb8eb18471045fdfedf"><td class="memItemLeft" align="right" valign="top">char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOfxSecurityData.html#ac29fe2ecb97aefb8eb18471045fdfedf">memo</a> [OFX_MEMO2_LENGTH]</td></tr>
<tr class="separator:ac29fe2ecb97aefb8eb18471045fdfedf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3b21ccb14b1e6cd0c23d5587e7ce51c1"><td class="memItemLeft" align="right" valign="top"><a id="a3b21ccb14b1e6cd0c23d5587e7ce51c1"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>memo_valid</b></td></tr>
<tr class="separator:a3b21ccb14b1e6cd0c23d5587e7ce51c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a09833d3d62eebdc026bf0aa2df01f789"><td class="memItemLeft" align="right" valign="top">char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOfxSecurityData.html#a09833d3d62eebdc026bf0aa2df01f789">fiid</a> [OFX_FIID_LENGTH]</td></tr>
<tr class="separator:a09833d3d62eebdc026bf0aa2df01f789"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac2fbfceb3bf84a0f6c455d783db81f62"><td class="memItemLeft" align="right" valign="top"><a id="ac2fbfceb3bf84a0f6c455d783db81f62"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>fiid_valid</b></td></tr>
<tr class="separator:ac2fbfceb3bf84a0f6c455d783db81f62"><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>An abstraction of a security, such as a stock, mutual fund, etc. </p>
<p>The <a class="el" href="structOfxSecurityData.html" title="An abstraction of a security, such as a stock, mutual fund, etc. ">OfxSecurityData</a> stucture is used to hols the securyty information inside a <a class="el" href="structOfxTransactionData.html" title="An abstraction of a transaction in an account. ">OfxTransactionData</a> struct for investment transactions. </p>

<p class="definition">Definition at line <a class="el" href="libofx_8h_source.html#l00352">352</a> of file <a class="el" href="libofx_8h_source.html">libofx.h</a>.</p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="a57f148fe703f73ea110e24c5470a9242"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a57f148fe703f73ea110e24c5470a9242">&#9670;&nbsp;</a></span>currency</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">char OfxSecurityData::currency[OFX_CURRENCY_LENGTH]</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>The currency is a string in ISO-4217 format. It overrides the one defined in the statement for the unit price </p>

<p class="definition">Definition at line <a class="el" href="libofx_8h_source.html#l00388">388</a> of file <a class="el" href="libofx_8h_source.html">libofx.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="ofx__container__statement_8cpp_source.html#l00050">OfxStatementContainer::add_attribute()</a>.</p>

</div>
</div>
<a id="a39f70a97d1390f293a9726a014ed5736"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a39f70a97d1390f293a9726a014ed5736">&#9670;&nbsp;</a></span>date_unitprice</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">time_t OfxSecurityData::date_unitprice</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>The date as of which the unit price was valid. </p>

<p class="definition">Definition at line <a class="el" href="libofx_8h_source.html#l00383">383</a> of file <a class="el" href="libofx_8h_source.html">libofx.h</a>.</p>

</div>
</div>
<a id="a09833d3d62eebdc026bf0aa2df01f789"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a09833d3d62eebdc026bf0aa2df01f789">&#9670;&nbsp;</a></span>fiid</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">char OfxSecurityData::fiid[OFX_FIID_LENGTH]</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>The currency is a string in ISO-4217 format. It overrides the one defined in the statement for the unit price </p>

<p class="definition">Definition at line <a class="el" href="libofx_8h_source.html#l00396">396</a> of file <a class="el" href="libofx_8h_source.html">libofx.h</a>.</p>

</div>
</div>
<a id="ac29fe2ecb97aefb8eb18471045fdfedf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac29fe2ecb97aefb8eb18471045fdfedf">&#9670;&nbsp;</a></span>memo</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">char OfxSecurityData::memo[OFX_MEMO2_LENGTH]</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Extra information not included in name </p>

<p class="definition">Definition at line <a class="el" href="libofx_8h_source.html#l00391">391</a> of file <a class="el" href="libofx_8h_source.html">libofx.h</a>.</p>

</div>
</div>
<a id="a6040f74d90d7e379069668e9377f05a7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6040f74d90d7e379069668e9377f05a7">&#9670;&nbsp;</a></span>secname</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">char OfxSecurityData::secname[OFX_SECNAME_LENGTH]</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>The full name of the security </p>

<p class="definition">Definition at line <a class="el" href="libofx_8h_source.html#l00368">368</a> of file <a class="el" href="libofx_8h_source.html">libofx.h</a>.</p>

</div>
</div>
<a id="afe1b8fb89161e47a1252bf6e6b13d624"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afe1b8fb89161e47a1252bf6e6b13d624">&#9670;&nbsp;</a></span>ticker</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">char OfxSecurityData::ticker[OFX_TICKER_LENGTH]</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>The ticker symbol of the security </p>

<p class="definition">Definition at line <a class="el" href="libofx_8h_source.html#l00376">376</a> of file <a class="el" href="libofx_8h_source.html">libofx.h</a>.</p>

</div>
</div>
<a id="a074c29532d07fe5dc782f50a5ce0bce5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a074c29532d07fe5dc782f50a5ce0bce5">&#9670;&nbsp;</a></span>unique_id</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">char OfxSecurityData::unique_id[OFX_UNIQUE_ID_LENGTH]</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>The id of the security being traded. </p>

<p class="definition">Definition at line <a class="el" href="libofx_8h_source.html#l00361">361</a> of file <a class="el" href="libofx_8h_source.html">libofx.h</a>.</p>

</div>
</div>
<a id="aaa852fc186b988a50d48b7b72b35d97b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaa852fc186b988a50d48b7b72b35d97b">&#9670;&nbsp;</a></span>unique_id_type</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">char OfxSecurityData::unique_id_type[OFX_UNIQUE_ID_TYPE_LENGTH]</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Usially "CUSIP" for FIs in north america </p>

<p class="definition">Definition at line <a class="el" href="libofx_8h_source.html#l00364">364</a> of file <a class="el" href="libofx_8h_source.html">libofx.h</a>.</p>

</div>
</div>
<a id="ab7e970b0d2efb4afd77e5140f6377eea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab7e970b0d2efb4afd77e5140f6377eea">&#9670;&nbsp;</a></span>unitprice</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double OfxSecurityData::unitprice</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>The price of each unit of the security, as of date_unitprice </p>

<p class="definition">Definition at line <a class="el" href="libofx_8h_source.html#l00379">379</a> of file <a class="el" href="libofx_8h_source.html">libofx.h</a>.</p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="libofx_8h_source.html">libofx.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="structOfxSecurityData.html">OfxSecurityData</a></li>
    <li class="footer">Generated on Tue Nov 28 2017 21:07:34 for LibOFX by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
  </ul>
</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.