Home Explore Help
Sign In
SoftwareDesign
/
csu3_am335x
8
0
Fork 0
Files Issues 0 Pull Requests 0 Wiki
Branch: master
Branches Tags
csu3_am335x
/
EVSE
/
GPL
/
tpm2-tss-3.2.0
/
doxygen-doc
/
html
/
group___fapi___create_seal.html

group___fapi___create_seal.html 18 KB
Permalink History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328 
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    2. 

  2. <html xmlns="http://www.w3.org/1999/xhtml">
    3. 

  3. <head>
    4. 

  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
    5. 

  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
    6. 

  6. <meta name="generator" content="Doxygen 1.8.13"/>
    7. 

  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
    8. 

  8. <title>tpm2-tss: Fapi_CreateSeal</title>
    9. 

  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
    10. 

  10. <script type="text/javascript" src="jquery.js"></script>
    11. 

  11. <script type="text/javascript" src="dynsections.js"></script>
    12. 

  12. <link href="navtree.css" rel="stylesheet" type="text/css"/>
    13. 

  13. <script type="text/javascript" src="resize.js"></script>
    14. 

  14. <script type="text/javascript" src="navtreedata.js"></script>
    15. 

  15. <script type="text/javascript" src="navtree.js"></script>
    16. 

  16. <script type="text/javascript">
    17. 

  17.   $(document).ready(initResizable);
    18. 

  18. </script>
    19. 

  19. <link href="doxygen.css" rel="stylesheet" type="text/css" />
    20. 

  20. </head>
    21. 

  21. <body>
    22. 

  22. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
    23. 

  23. <div id="titlearea">
    24. 

  24. <table cellspacing="0" cellpadding="0">
    25. 

  25.  <tbody>
    26. 

  26.  <tr style="height: 56px;">
    27. 

  27.   <td id="projectalign" style="padding-left: 0.5em;">
    28. 

  28.    <div id="projectname">tpm2-tss
    29. 

  29.    &#160;<span id="projectnumber">3.2.0</span>
    30. 

  30.    </div>
    31. 

  31.    <div id="projectbrief">TPM Software stack 2.0 TCG spec compliant implementation</div>
    32. 

  32.   </td>
    33. 

  33.  </tr>
    34. 

  34.  </tbody>
    35. 

  35. </table>
    36. 

  36. </div>
    37. 

  37. <!-- end header part -->
    38. 

  38. <!-- Generated by Doxygen 1.8.13 -->
    39. 

  39. <script type="text/javascript" src="menudata.js"></script>
    40. 

  40. <script type="text/javascript" src="menu.js"></script>
    41. 

  41. <script type="text/javascript">
    42. 

  42. $(function() {
    43. 

  43.   initMenu('',false,false,'search.php','Search');
    44. 

  44. });
    45. 

  45. </script>
    46. 

  46. <div id="main-nav"></div>
    47. 

  47. </div><!-- top -->
    48. 

  48. <div id="side-nav" class="ui-resizable side-nav-resizable">
    49. 

  49.   <div id="nav-tree">
    50. 

  50.     <div id="nav-tree-contents">
    51. 

  51.       <div id="nav-sync" class="sync"></div>
    52. 

  52.     </div>
    53. 

  53.   </div>
    54. 

  54.   <div id="splitbar" style="-moz-user-select:none;" 
    55. 

  55.        class="ui-resizable-handle">
    56. 

  56.   </div>
    57. 

  57. </div>
    58. 

  58. <script type="text/javascript">
    59. 

  59. $(document).ready(function(){initNavTree('group___fapi___create_seal.html','');});
    60. 

  60. </script>
    61. 

  61. <div id="doc-content">
    62. 

  62. <div class="header">
    63. 

  63.   <div class="summary">
    64. 

  64. <a href="#func-members">Functions</a>  </div>
    65. 

  65.   <div class="headertitle">
    66. 

  66. <div class="title">Fapi_CreateSeal<div class="ingroups"><a class="el" href="group__fapi.html">Feature API</a></div></div>  </div>
    67. 

  67. </div><!--header-->
    68. 

  68. <div class="contents">
    69. 

  69. <table class="memberdecls">
    70. 

  70. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
    71. 

  71. Functions</h2></td></tr>
    72. 

  72. <tr class="memitem:gad4be1e3712f93626d6000f3ccd850c65"><td class="memItemLeft" align="right" valign="top">TSS2_RC&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___fapi___create_seal.html#gad4be1e3712f93626d6000f3ccd850c65">Fapi_CreateSeal</a> (<a class="el" href="struct_f_a_p_i___c_o_n_t_e_x_t.html">FAPI_CONTEXT</a> *context, char const *path, char const *type, size_t size, char const *policyPath, char const *authValue, uint8_t const *data)</td></tr>
    73. 

  73. <tr class="separator:gad4be1e3712f93626d6000f3ccd850c65"><td class="memSeparator" colspan="2">&#160;</td></tr>
    74. 

  74. <tr class="memitem:ga55bc5471d80b0c0173cd3424f6f562ac"><td class="memItemLeft" align="right" valign="top">TSS2_RC&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___fapi___create_seal.html#ga55bc5471d80b0c0173cd3424f6f562ac">Fapi_CreateSeal_Async</a> (<a class="el" href="struct_f_a_p_i___c_o_n_t_e_x_t.html">FAPI_CONTEXT</a> *context, char const *path, char const *type, size_t size, char const *policyPath, char const *authValue, uint8_t const *data)</td></tr>
    75. 

  75. <tr class="separator:ga55bc5471d80b0c0173cd3424f6f562ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
    76. 

  76. <tr class="memitem:ga59b2acdbddb95d4da047703a6901f2da"><td class="memItemLeft" align="right" valign="top">TSS2_RC&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___fapi___create_seal.html#ga59b2acdbddb95d4da047703a6901f2da">Fapi_CreateSeal_Finish</a> (<a class="el" href="struct_f_a_p_i___c_o_n_t_e_x_t.html">FAPI_CONTEXT</a> *context)</td></tr>
    77. 

  77. <tr class="separator:ga59b2acdbddb95d4da047703a6901f2da"><td class="memSeparator" colspan="2">&#160;</td></tr>
    78. 

  78. </table>
    79. 

  79. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
    80. 

  80. <p>FAPI functions to invoke CreateSeal either as one-call or in an asynchronous manner. </p>
    81. 

  81. <h2 class="groupheader">Function Documentation</h2>
    82. 

  82. <a id="gad4be1e3712f93626d6000f3ccd850c65"></a>
    83. 

  83. <h2 class="memtitle"><span class="permalink"><a href="#gad4be1e3712f93626d6000f3ccd850c65">&#9670;&nbsp;</a></span>Fapi_CreateSeal()</h2>
    84. 

  84. 

  85. <div class="memitem">
    86. 

  86. <div class="memproto">
    87. 

  87.       <table class="memname">
    88. 

  88.         <tr>
    89. 

  89.           <td class="memname">Fapi_CreateSeal </td>
    90. 

  90.           <td>(</td>
    91. 

  91.           <td class="paramtype"><a class="el" href="struct_f_a_p_i___c_o_n_t_e_x_t.html">FAPI_CONTEXT</a> *&#160;</td>
    92. 

  92.           <td class="paramname"><em>context</em>, </td>
    93. 

  93.         </tr>
    94. 

  94.         <tr>
    95. 

  95.           <td class="paramkey"></td>
    96. 

  96.           <td></td>
    97. 

  97.           <td class="paramtype">char const *&#160;</td>
    98. 

  98.           <td class="paramname"><em>path</em>, </td>
    99. 

  99.         </tr>
    100. 

  100.         <tr>
    101. 

  101.           <td class="paramkey"></td>
    102. 

  102.           <td></td>
    103. 

  103.           <td class="paramtype">char const *&#160;</td>
    104. 

  104.           <td class="paramname"><em>type</em>, </td>
    105. 

  105.         </tr>
    106. 

  106.         <tr>
    107. 

  107.           <td class="paramkey"></td>
    108. 

  108.           <td></td>
    109. 

  109.           <td class="paramtype">size_t&#160;</td>
    110. 

  110.           <td class="paramname"><em>size</em>, </td>
    111. 

  111.         </tr>
    112. 

  112.         <tr>
    113. 

  113.           <td class="paramkey"></td>
    114. 

  114.           <td></td>
    115. 

  115.           <td class="paramtype">char const *&#160;</td>
    116. 

  116.           <td class="paramname"><em>policyPath</em>, </td>
    117. 

  117.         </tr>
    118. 

  118.         <tr>
    119. 

  119.           <td class="paramkey"></td>
    120. 

  120.           <td></td>
    121. 

  121.           <td class="paramtype">char const *&#160;</td>
    122. 

  122.           <td class="paramname"><em>authValue</em>, </td>
    123. 

  123.         </tr>
    124. 

  124.         <tr>
    125. 

  125.           <td class="paramkey"></td>
    126. 

  126.           <td></td>
    127. 

  127.           <td class="paramtype">uint8_t const *&#160;</td>
    128. 

  128.           <td class="paramname"><em>data</em>&#160;</td>
    129. 

  129.         </tr>
    130. 

  130.         <tr>
    131. 

  131.           <td></td>
    132. 

  132.           <td>)</td>
    133. 

  133.           <td></td><td></td>
    134. 

  134.         </tr>
    135. 

  135.       </table>
    136. 

  136. </div><div class="memdoc">
    137. 

  137. <p>One-Call function for Fapi_CreateSeal</p>
    138. 

  138. <p>Creates a sealed object and stores it in the FAPI metadata store. If no data is provided, the TPM generates random data to fill the sealed object.</p>
    139. 

  139. <dl class="params"><dt>Parameters</dt><dd>
    140. 

  140.   <table class="params">
    141. 

  141.     <tr><td class="paramdir">[in,out]</td><td class="paramname">context</td><td>The <a class="el" href="struct_f_a_p_i___c_o_n_t_e_x_t.html">FAPI_CONTEXT</a> </td></tr>
    142. 

  142.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>The path to the new sealed object </td></tr>
    143. 

  143.     <tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>The type of the new sealed object. May be NULL </td></tr>
    144. 

  144.     <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>The size of the new sealed object. Must not be 0 </td></tr>
    145. 

  145.     <tr><td class="paramdir">[in]</td><td class="paramname">policyPath</td><td>The path to the policy that is associated with the new sealed object. May be NULL </td></tr>
    146. 

  146.     <tr><td class="paramdir">[in]</td><td class="paramname">authValue</td><td>The authorization value for the new sealed object. May be NULL </td></tr>
    147. 

  147.     <tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>The data that is to be sealed within the new object. May be NULL</td></tr>
    148. 

  148.   </table>
    149. 

  149.   </dd>
    150. 

  150. </dl>
    151. 

  151. <dl class="retval"><dt>Return values</dt><dd>
    152. 

  152.   <table class="retval">
    153. 

  153.     <tr><td class="paramname">TSS2_RC_SUCCESS</td><td>if the function call was a success. </td></tr>
    154. 

  154.     <tr><td class="paramname">TSS2_FAPI_RC_BAD_REFERENCE</td><td>if context, or path is NULL. </td></tr>
    155. 

  155.     <tr><td class="paramname">TSS2_FAPI_RC_BAD_CONTEXT</td><td>if context corruption is detected. </td></tr>
    156. 

  156.     <tr><td class="paramname">TSS2_FAPI_RC_KEY_NOT_FOUND</td><td>if the parent key does not map to a FAPI key. </td></tr>
    157. 

  157.     <tr><td class="paramname">TSS2_FAPI_RC_BAD_PATH</td><td>if policyPath is non-NULL and does not map to a FAPI key. </td></tr>
    158. 

  158.     <tr><td class="paramname">TSS2_FAPI_RC_PATH_ALREADY_EXISTS</td><td>if a sealed object already exists at path. </td></tr>
    159. 

  159.     <tr><td class="paramname">TSS2_FAPI_RC_BAD_VALUE</td><td>if the keyType is invalid. </td></tr>
    160. 

  160.     <tr><td class="paramname">TSS2_FAPI_RC_BAD_SEQUENCE</td><td>if the context has an asynchronous operation already pending. </td></tr>
    161. 

  161.     <tr><td class="paramname">TSS2_FAPI_RC_IO_ERROR</td><td>if the data cannot be saved. </td></tr>
    162. 

  162.     <tr><td class="paramname">TSS2_FAPI_RC_MEMORY</td><td>if the FAPI cannot allocate enough memory for internal operations or return parameters. </td></tr>
    163. 

  163.     <tr><td class="paramname">TSS2_FAPI_RC_NO_TPM</td><td>if FAPI was initialized in no-TPM-mode via its config file. </td></tr>
    164. 

  164.     <tr><td class="paramname">TSS2_FAPI_RC_TRY_AGAIN</td><td>if an I/O operation is not finished yet and this function needs to be called again. </td></tr>
    165. 

  165.     <tr><td class="paramname">TSS2_FAPI_RC_AUTHORIZATION_UNKNOWN</td><td>if a required authorization callback is not set. </td></tr>
    166. 

  166.     <tr><td class="paramname">TSS2_ESYS_RC_*</td><td>possible error codes of ESAPI. </td></tr>
    167. 

  167.     <tr><td class="paramname">TSS2_FAPI_RC_PATH_NOT_FOUND</td><td>if a FAPI object path was not found during authorization. </td></tr>
    168. 

  168.     <tr><td class="paramname">TSS2_FAPI_RC_GENERAL_FAILURE</td><td>if an internal error occured. </td></tr>
    169. 

  169.     <tr><td class="paramname">TSS2_FAPI_RC_NOT_PROVISIONED</td><td>FAPI was not provisioned. </td></tr>
    170. 

  170.     <tr><td class="paramname">TSS2_FAPI_RC_AUTHORIZATION_FAILED</td><td>if the authorization attempt fails. </td></tr>
    171. 

  171.     <tr><td class="paramname">TSS2_FAPI_RC_POLICY_UNKNOWN</td><td>if policy search for a certain policy digest was not successful. </td></tr>
    172. 

  172.   </table>
    173. 

  173.   </dd>
    174. 

  174. </dl>
    175. 

  175. 

  176. </div>
    177. 

  177. </div>
    178. 

  178. <a id="ga55bc5471d80b0c0173cd3424f6f562ac"></a>
    179. 

  179. <h2 class="memtitle"><span class="permalink"><a href="#ga55bc5471d80b0c0173cd3424f6f562ac">&#9670;&nbsp;</a></span>Fapi_CreateSeal_Async()</h2>
    180. 

  180. 

  181. <div class="memitem">
    182. 

  182. <div class="memproto">
    183. 

  183.       <table class="memname">
    184. 

  184.         <tr>
    185. 

  185.           <td class="memname">Fapi_CreateSeal_Async </td>
    186. 

  186.           <td>(</td>
    187. 

  187.           <td class="paramtype"><a class="el" href="struct_f_a_p_i___c_o_n_t_e_x_t.html">FAPI_CONTEXT</a> *&#160;</td>
    188. 

  188.           <td class="paramname"><em>context</em>, </td>
    189. 

  189.         </tr>
    190. 

  190.         <tr>
    191. 

  191.           <td class="paramkey"></td>
    192. 

  192.           <td></td>
    193. 

  193.           <td class="paramtype">char const *&#160;</td>
    194. 

  194.           <td class="paramname"><em>path</em>, </td>
    195. 

  195.         </tr>
    196. 

  196.         <tr>
    197. 

  197.           <td class="paramkey"></td>
    198. 

  198.           <td></td>
    199. 

  199.           <td class="paramtype">char const *&#160;</td>
    200. 

  200.           <td class="paramname"><em>type</em>, </td>
    201. 

  201.         </tr>
    202. 

  202.         <tr>
    203. 

  203.           <td class="paramkey"></td>
    204. 

  204.           <td></td>
    205. 

  205.           <td class="paramtype">size_t&#160;</td>
    206. 

  206.           <td class="paramname"><em>size</em>, </td>
    207. 

  207.         </tr>
    208. 

  208.         <tr>
    209. 

  209.           <td class="paramkey"></td>
    210. 

  210.           <td></td>
    211. 

  211.           <td class="paramtype">char const *&#160;</td>
    212. 

  212.           <td class="paramname"><em>policyPath</em>, </td>
    213. 

  213.         </tr>
    214. 

  214.         <tr>
    215. 

  215.           <td class="paramkey"></td>
    216. 

  216.           <td></td>
    217. 

  217.           <td class="paramtype">char const *&#160;</td>
    218. 

  218.           <td class="paramname"><em>authValue</em>, </td>
    219. 

  219.         </tr>
    220. 

  220.         <tr>
    221. 

  221.           <td class="paramkey"></td>
    222. 

  222.           <td></td>
    223. 

  223.           <td class="paramtype">uint8_t const *&#160;</td>
    224. 

  224.           <td class="paramname"><em>data</em>&#160;</td>
    225. 

  225.         </tr>
    226. 

  226.         <tr>
    227. 

  227.           <td></td>
    228. 

  228.           <td>)</td>
    229. 

  229.           <td></td><td></td>
    230. 

  230.         </tr>
    231. 

  231.       </table>
    232. 

  232. </div><div class="memdoc">
    233. 

  233. <p>Asynchronous function for Fapi_CreateSeal</p>
    234. 

  234. <p>Creates a sealed object and stores it in the FAPI metadata store. If no data is provided, the TPM generates random data to fill the sealed object.</p>
    235. 

  235. <p>Call Fapi_CreateSeal_Finish to finish the execution of this command.</p>
    236. 

  236. <dl class="params"><dt>Parameters</dt><dd>
    237. 

  237.   <table class="params">
    238. 

  238.     <tr><td class="paramdir">[in,out]</td><td class="paramname">context</td><td>The <a class="el" href="struct_f_a_p_i___c_o_n_t_e_x_t.html">FAPI_CONTEXT</a> </td></tr>
    239. 

  239.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>The path to the new sealed object </td></tr>
    240. 

  240.     <tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>The type of the new sealed object. May be NULL </td></tr>
    241. 

  241.     <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>The size of the new sealed object. Must not be 0 </td></tr>
    242. 

  242.     <tr><td class="paramdir">[in]</td><td class="paramname">policyPath</td><td>The path to the policy that is associated with the new sealed object. May be NULL </td></tr>
    243. 

  243.     <tr><td class="paramdir">[in]</td><td class="paramname">authValue</td><td>The authorization value for the new sealed object. May be NULL </td></tr>
    244. 

  244.     <tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>The data that is to be sealed within the new object. May be NULL</td></tr>
    245. 

  245.   </table>
    246. 

  246.   </dd>
    247. 

  247. </dl>
    248. 

  248. <dl class="retval"><dt>Return values</dt><dd>
    249. 

  249.   <table class="retval">
    250. 

  250.     <tr><td class="paramname">TSS2_RC_SUCCESS</td><td>if the function call was a success. </td></tr>
    251. 

  251.     <tr><td class="paramname">TSS2_FAPI_RC_BAD_REFERENCE</td><td>if context, or path is NULL. </td></tr>
    252. 

  252.     <tr><td class="paramname">TSS2_FAPI_RC_BAD_CONTEXT</td><td>if context corruption is detected. </td></tr>
    253. 

  253.     <tr><td class="paramname">TSS2_FAPI_RC_KEY_NOT_FOUND</td><td>if the parent key does not map to a FAPI key. </td></tr>
    254. 

  254.     <tr><td class="paramname">TSS2_FAPI_RC_BAD_PATH</td><td>if policyPath is non-NULL and does not map to a FAPI key. </td></tr>
    255. 

  255.     <tr><td class="paramname">TSS2_FAPI_RC_PATH_ALREADY_EXISTS</td><td>if a sealed object already exists at path. </td></tr>
    256. 

  256.     <tr><td class="paramname">TSS2_FAPI_RC_BAD_VALUE</td><td>if the keyType is invalid. </td></tr>
    257. 

  257.     <tr><td class="paramname">TSS2_FAPI_RC_BAD_SEQUENCE</td><td>if the context has an asynchronous operation already pending. </td></tr>
    258. 

  258.     <tr><td class="paramname">TSS2_FAPI_RC_IO_ERROR</td><td>if the data cannot be saved. </td></tr>
    259. 

  259.     <tr><td class="paramname">TSS2_FAPI_RC_MEMORY</td><td>if the FAPI cannot allocate enough memory for internal operations or return parameters. </td></tr>
    260. 

  260.     <tr><td class="paramname">TSS2_FAPI_RC_NO_TPM</td><td>if FAPI was initialized in no-TPM-mode via its config file. </td></tr>
    261. 

  261.     <tr><td class="paramname">TSS2_FAPI_RC_PATH_NOT_FOUND</td><td>if a FAPI object path was not found during authorization. </td></tr>
    262. 

  262.   </table>
    263. 

  263.   </dd>
    264. 

  264. </dl>
    265. 

  265. 

  266. </div>
    267. 

  267. </div>
    268. 

  268. <a id="ga59b2acdbddb95d4da047703a6901f2da"></a>
    269. 

  269. <h2 class="memtitle"><span class="permalink"><a href="#ga59b2acdbddb95d4da047703a6901f2da">&#9670;&nbsp;</a></span>Fapi_CreateSeal_Finish()</h2>
    270. 

  270. 

  271. <div class="memitem">
    272. 

  272. <div class="memproto">
    273. 

  273.       <table class="memname">
    274. 

  274.         <tr>
    275. 

  275.           <td class="memname">Fapi_CreateSeal_Finish </td>
    276. 

  276.           <td>(</td>
    277. 

  277.           <td class="paramtype"><a class="el" href="struct_f_a_p_i___c_o_n_t_e_x_t.html">FAPI_CONTEXT</a> *&#160;</td>
    278. 

  278.           <td class="paramname"><em>context</em></td><td>)</td>
    279. 

  279.           <td></td>
    280. 

  280.         </tr>
    281. 

  281.       </table>
    282. 

  282. </div><div class="memdoc">
    283. 

  283. <p>Asynchronous finish function for Fapi_CreateSeal</p>
    284. 

  284. <p>This function should be called after a previous Fapi_CreateSeal.</p>
    285. 

  285. <dl class="params"><dt>Parameters</dt><dd>
    286. 

  286.   <table class="params">
    287. 

  287.     <tr><td class="paramdir">[in,out]</td><td class="paramname">context</td><td>The <a class="el" href="struct_f_a_p_i___c_o_n_t_e_x_t.html">FAPI_CONTEXT</a></td></tr>
    288. 

  288.   </table>
    289. 

  289.   </dd>
    290. 

  290. </dl>
    291. 

  291. <dl class="retval"><dt>Return values</dt><dd>
    292. 

  292.   <table class="retval">
    293. 

  293.     <tr><td class="paramname">TSS2_RC_SUCCESS</td><td>if the function call was a success. </td></tr>
    294. 

  294.     <tr><td class="paramname">TSS2_FAPI_RC_BAD_REFERENCE</td><td>if context is NULL. </td></tr>
    295. 

  295.     <tr><td class="paramname">TSS2_FAPI_RC_BAD_CONTEXT</td><td>if context corruption is detected. </td></tr>
    296. 

  296.     <tr><td class="paramname">TSS2_FAPI_RC_BAD_SEQUENCE</td><td>if the context has an asynchronous operation already pending. </td></tr>
    297. 

  297.     <tr><td class="paramname">TSS2_FAPI_RC_IO_ERROR</td><td>if the data cannot be saved. </td></tr>
    298. 

  298.     <tr><td class="paramname">TSS2_FAPI_RC_MEMORY</td><td>if the FAPI cannot allocate enough memory for internal operations or return parameters. </td></tr>
    299. 

  299.     <tr><td class="paramname">TSS2_FAPI_RC_TRY_AGAIN</td><td>if the asynchronous operation is not yet complete. Call this function again later. </td></tr>
    300. 

  300.     <tr><td class="paramname">TSS2_FAPI_RC_BAD_VALUE</td><td>if an invalid value was passed into the function. </td></tr>
    301. 

  301.     <tr><td class="paramname">TSS2_FAPI_RC_AUTHORIZATION_UNKNOWN</td><td>if a required authorization callback is not set. </td></tr>
    302. 

  302.     <tr><td class="paramname">TSS2_ESYS_RC_*</td><td>possible error codes of ESAPI. </td></tr>
    303. 

  303.     <tr><td class="paramname">TSS2_FAPI_RC_GENERAL_FAILURE</td><td>if an internal error occured. </td></tr>
    304. 

  304.     <tr><td class="paramname">TSS2_FAPI_RC_NOT_PROVISIONED</td><td>FAPI was not provisioned. </td></tr>
    305. 

  305.     <tr><td class="paramname">TSS2_FAPI_RC_KEY_NOT_FOUND</td><td>if a key was not found. </td></tr>
    306. 

  306.     <tr><td class="paramname">TSS2_FAPI_RC_BAD_PATH</td><td>if the path is used in inappropriate context or contains illegal characters. </td></tr>
    307. 

  307.     <tr><td class="paramname">TSS2_FAPI_RC_PATH_NOT_FOUND</td><td>if a FAPI object path was not found during authorization. </td></tr>
    308. 

  308.     <tr><td class="paramname">TSS2_FAPI_RC_AUTHORIZATION_FAILED</td><td>if the authorization attempt fails. </td></tr>
    309. 

  309.     <tr><td class="paramname">TSS2_FAPI_RC_POLICY_UNKNOWN</td><td>if policy search for a certain policy digest was not successful. </td></tr>
    310. 

  310.     <tr><td class="paramname">TSS2_FAPI_RC_PATH_ALREADY_EXISTS</td><td>if the object already exists in object store. </td></tr>
    311. 

  311.   </table>
    312. 

  312.   </dd>
    313. 

  313. </dl>
    314. 

  314. 

  315. </div>
    316. 

  316. </div>
    317. 

  317. </div><!-- contents -->
    318. 

  318. </div><!-- doc-content -->
    319. 

  319. <!-- start footer part -->
    320. 

  320. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
    321. 

  321.   <ul>
    322. 

  322.     <li class="footer">Generated by
    323. 

  323.     <a href="http://www.doxygen.org/index.html">
    324. 

  324.     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
    325. 

  325.   </ul>
    326. 

  326. </div>
    327. 

  327. </body>
    328. 

  328. </html>
    329.