Эхлэл Бүгдийг харах Тусламж
Нэвтрэх
SoftwareDesign
/
csu3_am335x
8
0
Салаа 0
Файлууд Асуудлууд 0 Хуулах хүсэлтүүд 0 Мэдлэгийн сан
Салаа: master
Салаанууд Тагууд
csu3_am335x
/
EVSE
/
GPL
/
tpm2-tss-3.2.0
/
doxygen-doc
/
html
/
group__ifapi__keystore.html

group__ifapi__keystore.html 55 KB
Байнгын холболт Түүх Анхны өгөгдөл

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027 
  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: Key store module</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__ifapi__keystore.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">Key store module<div class="ingroups"><a class="el" href="group__fapi.html">Feature API</a> &raquo; <a class="el" href="group__ifapi.html">Internals of 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:gafabb0a59d18b036c7d3cc083aee10dfb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ifapi__keystore.html#gafabb0a59d18b036c7d3cc083aee10dfb">ifapi_cleanup_ifapi_duplicate</a> (<a class="el" href="struct_i_f_a_p_i___d_u_p_l_i_c_a_t_e.html">IFAPI_DUPLICATE</a> *duplicate)</td></tr>
    73. 

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

  74. <tr class="memitem:gaaa33b0570f924b7418fddc46bc8c0ed6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ifapi__keystore.html#gaaa33b0570f924b7418fddc46bc8c0ed6">ifapi_cleanup_ifapi_ext_pub_key</a> (<a class="el" href="struct_i_f_a_p_i___e_x_t___p_u_b___k_e_y.html">IFAPI_EXT_PUB_KEY</a> *key)</td></tr>
    75. 

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

  76. <tr class="memitem:gaa87362683c0d4c3849bbbaa7f20ce1f7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ifapi__keystore.html#gaa87362683c0d4c3849bbbaa7f20ce1f7">ifapi_cleanup_ifapi_hierarchy</a> (<a class="el" href="struct_i_f_a_p_i___h_i_e_r_a_r_c_h_y.html">IFAPI_HIERARCHY</a> *hierarchy)</td></tr>
    77. 

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

  78. <tr class="memitem:gafdde064639939831b2ffc5ce65b47fff"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ifapi__keystore.html#gafdde064639939831b2ffc5ce65b47fff">ifapi_cleanup_ifapi_key</a> (<a class="el" href="struct_i_f_a_p_i___k_e_y.html">IFAPI_KEY</a> *key)</td></tr>
    79. 

  79. <tr class="separator:gafdde064639939831b2ffc5ce65b47fff"><td class="memSeparator" colspan="2">&#160;</td></tr>
    80. 

  80. <tr class="memitem:gaead62f5bcafdb03059407489c811f11e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ifapi__keystore.html#gaead62f5bcafdb03059407489c811f11e">ifapi_cleanup_ifapi_keystore</a> (<a class="el" href="struct_i_f_a_p_i___k_e_y_s_t_o_r_e.html">IFAPI_KEYSTORE</a> *keystore)</td></tr>
    81. 

  81. <tr class="separator:gaead62f5bcafdb03059407489c811f11e"><td class="memSeparator" colspan="2">&#160;</td></tr>
    82. 

  82. <tr class="memitem:gaff395a5d7935eb45f919b2dc69cd4349"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ifapi__keystore.html#gaff395a5d7935eb45f919b2dc69cd4349">ifapi_cleanup_ifapi_nv</a> (<a class="el" href="struct_i_f_a_p_i___n_v.html">IFAPI_NV</a> *nv)</td></tr>
    83. 

  83. <tr class="separator:gaff395a5d7935eb45f919b2dc69cd4349"><td class="memSeparator" colspan="2">&#160;</td></tr>
    84. 

  84. <tr class="memitem:gac6b0773d734df895630a880c98163bb0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ifapi__keystore.html#gac6b0773d734df895630a880c98163bb0">ifapi_cleanup_ifapi_object</a> (<a class="el" href="struct___i_f_a_p_i___o_b_j_e_c_t.html">IFAPI_OBJECT</a> *object)</td></tr>
    85. 

  85. <tr class="separator:gac6b0773d734df895630a880c98163bb0"><td class="memSeparator" colspan="2">&#160;</td></tr>
    86. 

  86. <tr class="memitem:ga55482c9b1bb6ee0b50426ecd7a7c8f61"><td class="memItemLeft" align="right" valign="top">TSS2_RC&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ifapi__keystore.html#ga55482c9b1bb6ee0b50426ecd7a7c8f61">ifapi_copy_ifapi_key</a> (<a class="el" href="struct_i_f_a_p_i___k_e_y.html">IFAPI_KEY</a> *dest, const <a class="el" href="struct_i_f_a_p_i___k_e_y.html">IFAPI_KEY</a> *src)</td></tr>
    87. 

  87. <tr class="separator:ga55482c9b1bb6ee0b50426ecd7a7c8f61"><td class="memSeparator" colspan="2">&#160;</td></tr>
    88. 

  88. <tr class="memitem:ga0dfb30704ead405b7786cdd15fe365a3"><td class="memItemLeft" align="right" valign="top">TSS2_RC&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ifapi__keystore.html#ga0dfb30704ead405b7786cdd15fe365a3">ifapi_copy_ifapi_key_object</a> (<a class="el" href="struct___i_f_a_p_i___o_b_j_e_c_t.html">IFAPI_OBJECT</a> *dest, const <a class="el" href="struct___i_f_a_p_i___o_b_j_e_c_t.html">IFAPI_OBJECT</a> *src)</td></tr>
    89. 

  89. <tr class="separator:ga0dfb30704ead405b7786cdd15fe365a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
    90. 

  90. <tr class="memitem:ga6bb0e3d58d2c8644dfddb509bde5d09b"><td class="memItemLeft" align="right" valign="top">TSS2_RC&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ifapi__keystore.html#ga6bb0e3d58d2c8644dfddb509bde5d09b">ifapi_keystore_delete</a> (<a class="el" href="struct_i_f_a_p_i___k_e_y_s_t_o_r_e.html">IFAPI_KEYSTORE</a> *keystore, char *path)</td></tr>
    91. 

  91. <tr class="separator:ga6bb0e3d58d2c8644dfddb509bde5d09b"><td class="memSeparator" colspan="2">&#160;</td></tr>
    92. 

  92. <tr class="memitem:ga7fe64f630dfab96d28d1206b36937003"><td class="memItemLeft" align="right" valign="top">TSS2_RC&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ifapi__keystore.html#ga7fe64f630dfab96d28d1206b36937003">ifapi_keystore_initialize</a> (<a class="el" href="struct_i_f_a_p_i___k_e_y_s_t_o_r_e.html">IFAPI_KEYSTORE</a> *keystore, const char *config_systemdir, const char *config_userdir, const char *config_defaultprofile)</td></tr>
    93. 

  93. <tr class="separator:ga7fe64f630dfab96d28d1206b36937003"><td class="memSeparator" colspan="2">&#160;</td></tr>
    94. 

  94. <tr class="memitem:ga7fe0097564cb4663a92f39e1620fc293"><td class="memItemLeft" align="right" valign="top">TSS2_RC&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ifapi__keystore.html#ga7fe0097564cb4663a92f39e1620fc293">ifapi_keystore_list_all</a> (<a class="el" href="struct_i_f_a_p_i___k_e_y_s_t_o_r_e.html">IFAPI_KEYSTORE</a> *keystore, const char *searchpath, char ***results, size_t *numresults)</td></tr>
    95. 

  95. <tr class="separator:ga7fe0097564cb4663a92f39e1620fc293"><td class="memSeparator" colspan="2">&#160;</td></tr>
    96. 

  96. <tr class="memitem:ga6af418f78dd03c860a428b14e0530213"><td class="memItemLeft" align="right" valign="top">TSS2_RC&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ifapi__keystore.html#ga6af418f78dd03c860a428b14e0530213">ifapi_keystore_load_async</a> (<a class="el" href="struct_i_f_a_p_i___k_e_y_s_t_o_r_e.html">IFAPI_KEYSTORE</a> *keystore, <a class="el" href="struct_i_f_a_p_i___i_o.html">IFAPI_IO</a> *io, const char *path)</td></tr>
    97. 

  97. <tr class="separator:ga6af418f78dd03c860a428b14e0530213"><td class="memSeparator" colspan="2">&#160;</td></tr>
    98. 

  98. <tr class="memitem:ga33837c1356e218bd96fd5ac58a8193b2"><td class="memItemLeft" align="right" valign="top"><a id="ga33837c1356e218bd96fd5ac58a8193b2"></a>
    99. 

  99. TSS2_RC&#160;</td><td class="memItemRight" valign="bottom"><b>ifapi_keystore_load_finish</b> (<a class="el" href="struct_i_f_a_p_i___k_e_y_s_t_o_r_e.html">IFAPI_KEYSTORE</a> *keystore, <a class="el" href="struct_i_f_a_p_i___i_o.html">IFAPI_IO</a> *io, <a class="el" href="struct___i_f_a_p_i___o_b_j_e_c_t.html">IFAPI_OBJECT</a> *object)</td></tr>
    100. 

  100. <tr class="separator:ga33837c1356e218bd96fd5ac58a8193b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
    101. 

  101. <tr class="memitem:ga6c893408be4f545cf9c056284e3eab28"><td class="memItemLeft" align="right" valign="top">TSS2_RC&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ifapi__keystore.html#ga6c893408be4f545cf9c056284e3eab28">ifapi_keystore_remove_directories</a> (<a class="el" href="struct_i_f_a_p_i___k_e_y_s_t_o_r_e.html">IFAPI_KEYSTORE</a> *keystore, const char *dir_name)</td></tr>
    102. 

  102. <tr class="separator:ga6c893408be4f545cf9c056284e3eab28"><td class="memSeparator" colspan="2">&#160;</td></tr>
    103. 

  103. <tr class="memitem:ga6ecdfa3a0394f1e2ef0c9bf81039ed81"><td class="memItemLeft" align="right" valign="top">TSS2_RC&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ifapi__keystore.html#ga6ecdfa3a0394f1e2ef0c9bf81039ed81">ifapi_keystore_search_nv_obj</a> (<a class="el" href="struct_i_f_a_p_i___k_e_y_s_t_o_r_e.html">IFAPI_KEYSTORE</a> *keystore, <a class="el" href="struct_i_f_a_p_i___i_o.html">IFAPI_IO</a> *io, TPM2B_NV_PUBLIC *nv_public, char **found_path)</td></tr>
    104. 

  104. <tr class="separator:ga6ecdfa3a0394f1e2ef0c9bf81039ed81"><td class="memSeparator" colspan="2">&#160;</td></tr>
    105. 

  105. <tr class="memitem:ga26224646067aa6f2e349a43345744fd5"><td class="memItemLeft" align="right" valign="top">TSS2_RC&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ifapi__keystore.html#ga26224646067aa6f2e349a43345744fd5">ifapi_keystore_search_obj</a> (<a class="el" href="struct_i_f_a_p_i___k_e_y_s_t_o_r_e.html">IFAPI_KEYSTORE</a> *keystore, <a class="el" href="struct_i_f_a_p_i___i_o.html">IFAPI_IO</a> *io, TPM2B_NAME *name, char **found_path)</td></tr>
    106. 

  106. <tr class="separator:ga26224646067aa6f2e349a43345744fd5"><td class="memSeparator" colspan="2">&#160;</td></tr>
    107. 

  107. <tr class="memitem:gaf8394ad181ae3e9130c4aec886cb091d"><td class="memItemLeft" align="right" valign="top">TSS2_RC&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ifapi__keystore.html#gaf8394ad181ae3e9130c4aec886cb091d">ifapi_keystore_store_async</a> (<a class="el" href="struct_i_f_a_p_i___k_e_y_s_t_o_r_e.html">IFAPI_KEYSTORE</a> *keystore, <a class="el" href="struct_i_f_a_p_i___i_o.html">IFAPI_IO</a> *io, const char *path, const <a class="el" href="struct___i_f_a_p_i___o_b_j_e_c_t.html">IFAPI_OBJECT</a> *object)</td></tr>
    108. 

  108. <tr class="separator:gaf8394ad181ae3e9130c4aec886cb091d"><td class="memSeparator" colspan="2">&#160;</td></tr>
    109. 

  109. <tr class="memitem:ga65efd616ba01aa737b3acf4c168c9148"><td class="memItemLeft" align="right" valign="top">TSS2_RC&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ifapi__keystore.html#ga65efd616ba01aa737b3acf4c168c9148">ifapi_copy_ifapi_hierarchy</a> (<a class="el" href="struct_i_f_a_p_i___h_i_e_r_a_r_c_h_y.html">IFAPI_HIERARCHY</a> *dest, const <a class="el" href="struct_i_f_a_p_i___h_i_e_r_a_r_c_h_y.html">IFAPI_HIERARCHY</a> *src)</td></tr>
    110. 

  110. <tr class="separator:ga65efd616ba01aa737b3acf4c168c9148"><td class="memSeparator" colspan="2">&#160;</td></tr>
    111. 

  111. <tr class="memitem:ga2b17a8bfeb50365b22cdefdb41bf1997"><td class="memItemLeft" align="right" valign="top">TSS2_RC&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ifapi__keystore.html#ga2b17a8bfeb50365b22cdefdb41bf1997">ifapi_copy_ifapi_hierarchy_object</a> (<a class="el" href="struct___i_f_a_p_i___o_b_j_e_c_t.html">IFAPI_OBJECT</a> *dest, const <a class="el" href="struct___i_f_a_p_i___o_b_j_e_c_t.html">IFAPI_OBJECT</a> *src)</td></tr>
    112. 

  112. <tr class="separator:ga2b17a8bfeb50365b22cdefdb41bf1997"><td class="memSeparator" colspan="2">&#160;</td></tr>
    113. 

  113. <tr class="memitem:ga24d8a92700486782021c434be1865992"><td class="memItemLeft" align="right" valign="top">TSS2_RC&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ifapi__keystore.html#ga24d8a92700486782021c434be1865992">ifapi_keystore_object_does_not_exist</a> (<a class="el" href="struct_i_f_a_p_i___k_e_y_s_t_o_r_e.html">IFAPI_KEYSTORE</a> *keystore, const char *path, const <a class="el" href="struct___i_f_a_p_i___o_b_j_e_c_t.html">IFAPI_OBJECT</a> *object)</td></tr>
    114. 

  114. <tr class="separator:ga24d8a92700486782021c434be1865992"><td class="memSeparator" colspan="2">&#160;</td></tr>
    115. 

  115. </table>
    116. 

  116. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
    117. 

  117. <p>Provides internal fapi functions for reading and writing to the key store. </p>
    118. 

  118. <h2 class="groupheader">Function Documentation</h2>
    119. 

  119. <a id="gafabb0a59d18b036c7d3cc083aee10dfb"></a>
    120. 

  120. <h2 class="memtitle"><span class="permalink"><a href="#gafabb0a59d18b036c7d3cc083aee10dfb">&#9670;&nbsp;</a></span>ifapi_cleanup_ifapi_duplicate()</h2>
    121. 

  121. 

  122. <div class="memitem">
    123. 

  123. <div class="memproto">
    124. 

  124.       <table class="memname">
    125. 

  125.         <tr>
    126. 

  126.           <td class="memname">void ifapi_cleanup_ifapi_duplicate </td>
    127. 

  127.           <td>(</td>
    128. 

  128.           <td class="paramtype"><a class="el" href="struct_i_f_a_p_i___d_u_p_l_i_c_a_t_e.html">IFAPI_DUPLICATE</a> *&#160;</td>
    129. 

  129.           <td class="paramname"><em>duplicate</em></td><td>)</td>
    130. 

  130.           <td></td>
    131. 

  131.         </tr>
    132. 

  132.       </table>
    133. 

  133. </div><div class="memdoc">
    134. 

  134. <p>Free memory allocated during deserialization of a duplicate object.</p>
    135. 

  135. <p>The duplicate object will not be freed (might be declared on the stack).</p>
    136. 

  136. <dl class="params"><dt>Parameters</dt><dd>
    137. 

  137.   <table class="params">
    138. 

  138.     <tr><td class="paramdir">[in]</td><td class="paramname">duplicate</td><td>The duplicate object to be cleaned up. </td></tr>
    139. 

  139.   </table>
    140. 

  140.   </dd>
    141. 

  141. </dl>
    142. 

  142. 

  143. </div>
    144. 

  144. </div>
    145. 

  145. <a id="gaaa33b0570f924b7418fddc46bc8c0ed6"></a>
    146. 

  146. <h2 class="memtitle"><span class="permalink"><a href="#gaaa33b0570f924b7418fddc46bc8c0ed6">&#9670;&nbsp;</a></span>ifapi_cleanup_ifapi_ext_pub_key()</h2>
    147. 

  147. 

  148. <div class="memitem">
    149. 

  149. <div class="memproto">
    150. 

  150.       <table class="memname">
    151. 

  151.         <tr>
    152. 

  152.           <td class="memname">void ifapi_cleanup_ifapi_ext_pub_key </td>
    153. 

  153.           <td>(</td>
    154. 

  154.           <td class="paramtype"><a class="el" href="struct_i_f_a_p_i___e_x_t___p_u_b___k_e_y.html">IFAPI_EXT_PUB_KEY</a> *&#160;</td>
    155. 

  155.           <td class="paramname"><em>key</em></td><td>)</td>
    156. 

  156.           <td></td>
    157. 

  157.         </tr>
    158. 

  158.       </table>
    159. 

  159. </div><div class="memdoc">
    160. 

  160. <p>Free memory allocated during deserialization of a pubkey object.</p>
    161. 

  161. <p>The pubkey will not be freed (might be declared on the stack).</p>
    162. 

  162. <dl class="params"><dt>Parameters</dt><dd>
    163. 

  163.   <table class="params">
    164. 

  164.     <tr><td class="paramdir">[in]</td><td class="paramname">key</td><td>The pubkey object to be cleaned up. </td></tr>
    165. 

  165.   </table>
    166. 

  166.   </dd>
    167. 

  167. </dl>
    168. 

  168. 

  169. </div>
    170. 

  170. </div>
    171. 

  171. <a id="gaa87362683c0d4c3849bbbaa7f20ce1f7"></a>
    172. 

  172. <h2 class="memtitle"><span class="permalink"><a href="#gaa87362683c0d4c3849bbbaa7f20ce1f7">&#9670;&nbsp;</a></span>ifapi_cleanup_ifapi_hierarchy()</h2>
    173. 

  173. 

  174. <div class="memitem">
    175. 

  175. <div class="memproto">
    176. 

  176.       <table class="memname">
    177. 

  177.         <tr>
    178. 

  178.           <td class="memname">void ifapi_cleanup_ifapi_hierarchy </td>
    179. 

  179.           <td>(</td>
    180. 

  180.           <td class="paramtype"><a class="el" href="struct_i_f_a_p_i___h_i_e_r_a_r_c_h_y.html">IFAPI_HIERARCHY</a> *&#160;</td>
    181. 

  181.           <td class="paramname"><em>hierarchy</em></td><td>)</td>
    182. 

  182.           <td></td>
    183. 

  183.         </tr>
    184. 

  184.       </table>
    185. 

  185. </div><div class="memdoc">
    186. 

  186. <p>Free memory allocated during deserialization of a hierarchy object.</p>
    187. 

  187. <p>The hierarchy object will not be freed (might be declared on the stack).</p>
    188. 

  188. <dl class="params"><dt>Parameters</dt><dd>
    189. 

  189.   <table class="params">
    190. 

  190.     <tr><td class="paramdir">[in]</td><td class="paramname">hierarchy</td><td>The hierarchy object to be cleaned up. </td></tr>
    191. 

  191.   </table>
    192. 

  192.   </dd>
    193. 

  193. </dl>
    194. 

  194. 

  195. </div>
    196. 

  196. </div>
    197. 

  197. <a id="gafdde064639939831b2ffc5ce65b47fff"></a>
    198. 

  198. <h2 class="memtitle"><span class="permalink"><a href="#gafdde064639939831b2ffc5ce65b47fff">&#9670;&nbsp;</a></span>ifapi_cleanup_ifapi_key()</h2>
    199. 

  199. 

  200. <div class="memitem">
    201. 

  201. <div class="memproto">
    202. 

  202.       <table class="memname">
    203. 

  203.         <tr>
    204. 

  204.           <td class="memname">void ifapi_cleanup_ifapi_key </td>
    205. 

  205.           <td>(</td>
    206. 

  206.           <td class="paramtype"><a class="el" href="struct_i_f_a_p_i___k_e_y.html">IFAPI_KEY</a> *&#160;</td>
    207. 

  207.           <td class="paramname"><em>key</em></td><td>)</td>
    208. 

  208.           <td></td>
    209. 

  209.         </tr>
    210. 

  210.       </table>
    211. 

  211. </div><div class="memdoc">
    212. 

  212. <p>Free memory allocated during deserialization of a key object.</p>
    213. 

  213. <p>The key will not be freed (might be declared on the stack).</p>
    214. 

  214. <dl class="params"><dt>Parameters</dt><dd>
    215. 

  215.   <table class="params">
    216. 

  216.     <tr><td class="paramdir">[in]</td><td class="paramname">key</td><td>The key object to be cleaned up. </td></tr>
    217. 

  217.   </table>
    218. 

  218.   </dd>
    219. 

  219. </dl>
    220. 

  220. 

  221. </div>
    222. 

  222. </div>
    223. 

  223. <a id="gaead62f5bcafdb03059407489c811f11e"></a>
    224. 

  224. <h2 class="memtitle"><span class="permalink"><a href="#gaead62f5bcafdb03059407489c811f11e">&#9670;&nbsp;</a></span>ifapi_cleanup_ifapi_keystore()</h2>
    225. 

  225. 

  226. <div class="memitem">
    227. 

  227. <div class="memproto">
    228. 

  228.       <table class="memname">
    229. 

  229.         <tr>
    230. 

  230.           <td class="memname">void ifapi_cleanup_ifapi_keystore </td>
    231. 

  231.           <td>(</td>
    232. 

  232.           <td class="paramtype"><a class="el" href="struct_i_f_a_p_i___k_e_y_s_t_o_r_e.html">IFAPI_KEYSTORE</a> *&#160;</td>
    233. 

  233.           <td class="paramname"><em>keystore</em></td><td>)</td>
    234. 

  234.           <td></td>
    235. 

  235.         </tr>
    236. 

  236.       </table>
    237. 

  237. </div><div class="memdoc">
    238. 

  238. <p>Free keystore related memory allocated during FAPI initialization.</p>
    239. 

  239. <p>The keystore object will not be freed (might be declared on the stack).</p>
    240. 

  240. <dl class="params"><dt>Parameters</dt><dd>
    241. 

  241.   <table class="params">
    242. 

  242.     <tr><td class="paramdir">[in]</td><td class="paramname">keystore</td><td>The kystore object to be cleaned up. </td></tr>
    243. 

  243.   </table>
    244. 

  244.   </dd>
    245. 

  245. </dl>
    246. 

  246. 

  247. </div>
    248. 

  248. </div>
    249. 

  249. <a id="gaff395a5d7935eb45f919b2dc69cd4349"></a>
    250. 

  250. <h2 class="memtitle"><span class="permalink"><a href="#gaff395a5d7935eb45f919b2dc69cd4349">&#9670;&nbsp;</a></span>ifapi_cleanup_ifapi_nv()</h2>
    251. 

  251. 

  252. <div class="memitem">
    253. 

  253. <div class="memproto">
    254. 

  254.       <table class="memname">
    255. 

  255.         <tr>
    256. 

  256.           <td class="memname">void ifapi_cleanup_ifapi_nv </td>
    257. 

  257.           <td>(</td>
    258. 

  258.           <td class="paramtype"><a class="el" href="struct_i_f_a_p_i___n_v.html">IFAPI_NV</a> *&#160;</td>
    259. 

  259.           <td class="paramname"><em>nv</em></td><td>)</td>
    260. 

  260.           <td></td>
    261. 

  261.         </tr>
    262. 

  262.       </table>
    263. 

  263. </div><div class="memdoc">
    264. 

  264. <p>Free memory allocated during deserialization of a nv object.</p>
    265. 

  265. <p>The nv object will not be freed (might be declared on the stack).</p>
    266. 

  266. <dl class="params"><dt>Parameters</dt><dd>
    267. 

  267.   <table class="params">
    268. 

  268.     <tr><td class="paramdir">[in]</td><td class="paramname">nv</td><td>The nv object to be cleaned up. </td></tr>
    269. 

  269.   </table>
    270. 

  270.   </dd>
    271. 

  271. </dl>
    272. 

  272. 

  273. </div>
    274. 

  274. </div>
    275. 

  275. <a id="gac6b0773d734df895630a880c98163bb0"></a>
    276. 

  276. <h2 class="memtitle"><span class="permalink"><a href="#gac6b0773d734df895630a880c98163bb0">&#9670;&nbsp;</a></span>ifapi_cleanup_ifapi_object()</h2>
    277. 

  277. 

  278. <div class="memitem">
    279. 

  279. <div class="memproto">
    280. 

  280.       <table class="memname">
    281. 

  281.         <tr>
    282. 

  282.           <td class="memname">void ifapi_cleanup_ifapi_object </td>
    283. 

  283.           <td>(</td>
    284. 

  284.           <td class="paramtype"><a class="el" href="struct___i_f_a_p_i___o_b_j_e_c_t.html">IFAPI_OBJECT</a> *&#160;</td>
    285. 

  285.           <td class="paramname"><em>object</em></td><td>)</td>
    286. 

  286.           <td></td>
    287. 

  287.         </tr>
    288. 

  288.       </table>
    289. 

  289. </div><div class="memdoc">
    290. 

  290. <p>Free memory allocated during deserialization of object.</p>
    291. 

  291. <p>The object will not be freed (might be declared on the stack).</p>
    292. 

  292. <dl class="params"><dt>Parameters</dt><dd>
    293. 

  293.   <table class="params">
    294. 

  294.     <tr><td class="paramdir">[in]</td><td class="paramname">object</td><td>The object to be cleaned up. </td></tr>
    295. 

  295.   </table>
    296. 

  296.   </dd>
    297. 

  297. </dl>
    298. 

  298. 

  299. </div>
    300. 

  300. </div>
    301. 

  301. <a id="ga65efd616ba01aa737b3acf4c168c9148"></a>
    302. 

  302. <h2 class="memtitle"><span class="permalink"><a href="#ga65efd616ba01aa737b3acf4c168c9148">&#9670;&nbsp;</a></span>ifapi_copy_ifapi_hierarchy()</h2>
    303. 

  303. 

  304. <div class="memitem">
    305. 

  305. <div class="memproto">
    306. 

  306.       <table class="memname">
    307. 

  307.         <tr>
    308. 

  308.           <td class="memname">ifapi_copy_ifapi_hierarchy </td>
    309. 

  309.           <td>(</td>
    310. 

  310.           <td class="paramtype"><a class="el" href="struct_i_f_a_p_i___h_i_e_r_a_r_c_h_y.html">IFAPI_HIERARCHY</a> *&#160;</td>
    311. 

  311.           <td class="paramname"><em>dest</em>, </td>
    312. 

  312.         </tr>
    313. 

  313.         <tr>
    314. 

  314.           <td class="paramkey"></td>
    315. 

  315.           <td></td>
    316. 

  316.           <td class="paramtype">const <a class="el" href="struct_i_f_a_p_i___h_i_e_r_a_r_c_h_y.html">IFAPI_HIERARCHY</a> *&#160;</td>
    317. 

  317.           <td class="paramname"><em>src</em>&#160;</td>
    318. 

  318.         </tr>
    319. 

  319.         <tr>
    320. 

  320.           <td></td>
    321. 

  321.           <td>)</td>
    322. 

  322.           <td></td><td></td>
    323. 

  323.         </tr>
    324. 

  324.       </table>
    325. 

  325. </div><div class="memdoc">
    326. 

  326. <p>Create a copy of a an ifapi hierarchy.</p>
    327. 

  327. <dl class="params"><dt>Parameters</dt><dd>
    328. 

  328.   <table class="params">
    329. 

  329.     <tr><td class="paramdir">[out]</td><td class="paramname">dest</td><td>The caller allocated hierarchy object which will be the destination of the copy operation. </td></tr>
    330. 

  330.     <tr><td class="paramdir">[in]</td><td class="paramname">src</td><td>The source hierarchy.</td></tr>
    331. 

  331.   </table>
    332. 

  332.   </dd>
    333. 

  333. </dl>
    334. 

  334. <dl class="retval"><dt>Return values</dt><dd>
    335. 

  335.   <table class="retval">
    336. 

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

  337.     <tr><td class="paramname">TSS2_FAPI_RC_BAD_REFERENCE</td><td>a invalid null pointer is passed. </td></tr>
    338. 

  338.     <tr><td class="paramname">TSS2_FAPI_RC_MEMORY</td><td>if not enough memory can be allocated. </td></tr>
    339. 

  339.   </table>
    340. 

  340.   </dd>
    341. 

  341. </dl>
    342. 

  342. 

  343. </div>
    344. 

  344. </div>
    345. 

  345. <a id="ga2b17a8bfeb50365b22cdefdb41bf1997"></a>
    346. 

  346. <h2 class="memtitle"><span class="permalink"><a href="#ga2b17a8bfeb50365b22cdefdb41bf1997">&#9670;&nbsp;</a></span>ifapi_copy_ifapi_hierarchy_object()</h2>
    347. 

  347. 

  348. <div class="memitem">
    349. 

  349. <div class="memproto">
    350. 

  350.       <table class="memname">
    351. 

  351.         <tr>
    352. 

  352.           <td class="memname">ifapi_copy_ifapi_hierarchy_object </td>
    353. 

  353.           <td>(</td>
    354. 

  354.           <td class="paramtype"><a class="el" href="struct___i_f_a_p_i___o_b_j_e_c_t.html">IFAPI_OBJECT</a> *&#160;</td>
    355. 

  355.           <td class="paramname"><em>dest</em>, </td>
    356. 

  356.         </tr>
    357. 

  357.         <tr>
    358. 

  358.           <td class="paramkey"></td>
    359. 

  359.           <td></td>
    360. 

  360.           <td class="paramtype">const <a class="el" href="struct___i_f_a_p_i___o_b_j_e_c_t.html">IFAPI_OBJECT</a> *&#160;</td>
    361. 

  361.           <td class="paramname"><em>src</em>&#160;</td>
    362. 

  362.         </tr>
    363. 

  363.         <tr>
    364. 

  364.           <td></td>
    365. 

  365.           <td>)</td>
    366. 

  366.           <td></td><td></td>
    367. 

  367.         </tr>
    368. 

  368.       </table>
    369. 

  369. </div><div class="memdoc">
    370. 

  370. <p>Create a copy of a an ifapi object storing a hierarchy.</p>
    371. 

  371. <p>The hierarchy together with the policy of the hierarchy will be copied.</p>
    372. 

  372. <dl class="params"><dt>Parameters</dt><dd>
    373. 

  373.   <table class="params">
    374. 

  374.     <tr><td class="paramdir">[out]</td><td class="paramname">dest</td><td>The caller allocated hierarchy object which will be the destination of the copy operation. </td></tr>
    375. 

  375.     <tr><td class="paramdir">[in]</td><td class="paramname">src</td><td>The source hieararchy.</td></tr>
    376. 

  376.   </table>
    377. 

  377.   </dd>
    378. 

  378. </dl>
    379. 

  379. <dl class="retval"><dt>Return values</dt><dd>
    380. 

  380.   <table class="retval">
    381. 

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

  382.     <tr><td class="paramname">TSS2_FAPI_RC_GENERAL_FAILURE</td><td>if the source is not of type key. </td></tr>
    383. 

  383.     <tr><td class="paramname">TSS2_FAPI_RC_BAD_REFERENCE</td><td>a invalid null pointer is passed. </td></tr>
    384. 

  384.     <tr><td class="paramname">TSS2_FAPI_RC_MEMORY</td><td>if not enough memory can be allocated. </td></tr>
    385. 

  385.   </table>
    386. 

  386.   </dd>
    387. 

  387. </dl>
    388. 

  388. 

  389. </div>
    390. 

  390. </div>
    391. 

  391. <a id="ga55482c9b1bb6ee0b50426ecd7a7c8f61"></a>
    392. 

  392. <h2 class="memtitle"><span class="permalink"><a href="#ga55482c9b1bb6ee0b50426ecd7a7c8f61">&#9670;&nbsp;</a></span>ifapi_copy_ifapi_key()</h2>
    393. 

  393. 

  394. <div class="memitem">
    395. 

  395. <div class="memproto">
    396. 

  396.       <table class="memname">
    397. 

  397.         <tr>
    398. 

  398.           <td class="memname">TSS2_RC ifapi_copy_ifapi_key </td>
    399. 

  399.           <td>(</td>
    400. 

  400.           <td class="paramtype"><a class="el" href="struct_i_f_a_p_i___k_e_y.html">IFAPI_KEY</a> *&#160;</td>
    401. 

  401.           <td class="paramname"><em>dest</em>, </td>
    402. 

  402.         </tr>
    403. 

  403.         <tr>
    404. 

  404.           <td class="paramkey"></td>
    405. 

  405.           <td></td>
    406. 

  406.           <td class="paramtype">const <a class="el" href="struct_i_f_a_p_i___k_e_y.html">IFAPI_KEY</a> *&#160;</td>
    407. 

  407.           <td class="paramname"><em>src</em>&#160;</td>
    408. 

  408.         </tr>
    409. 

  409.         <tr>
    410. 

  410.           <td></td>
    411. 

  411.           <td>)</td>
    412. 

  412.           <td></td><td></td>
    413. 

  413.         </tr>
    414. 

  414.       </table>
    415. 

  415. </div><div class="memdoc">
    416. 

  416. <p>Create a copy of a an ifapi key.</p>
    417. 

  417. <dl class="params"><dt>Parameters</dt><dd>
    418. 

  418.   <table class="params">
    419. 

  419.     <tr><td class="paramdir">[out]</td><td class="paramname">dest</td><td>The caller allocated key object which will be the destination of the copy operation. </td></tr>
    420. 

  420.     <tr><td class="paramdir">[in]</td><td class="paramname">src</td><td>The source key.</td></tr>
    421. 

  421.   </table>
    422. 

  422.   </dd>
    423. 

  423. </dl>
    424. 

  424. <dl class="retval"><dt>Return values</dt><dd>
    425. 

  425.   <table class="retval">
    426. 

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

  427.     <tr><td class="paramname">TSS2_FAPI_RC_BAD_REFERENCE</td><td>a invalid null pointer is passed. </td></tr>
    428. 

  428.     <tr><td class="paramname">TSS2_FAPI_RC_MEMORY</td><td>if not enough memory can be allocated. </td></tr>
    429. 

  429.   </table>
    430. 

  430.   </dd>
    431. 

  431. </dl>
    432. 

  432. 

  433. </div>
    434. 

  434. </div>
    435. 

  435. <a id="ga0dfb30704ead405b7786cdd15fe365a3"></a>
    436. 

  436. <h2 class="memtitle"><span class="permalink"><a href="#ga0dfb30704ead405b7786cdd15fe365a3">&#9670;&nbsp;</a></span>ifapi_copy_ifapi_key_object()</h2>
    437. 

  437. 

  438. <div class="memitem">
    439. 

  439. <div class="memproto">
    440. 

  440.       <table class="memname">
    441. 

  441.         <tr>
    442. 

  442.           <td class="memname">TSS2_RC ifapi_copy_ifapi_key_object </td>
    443. 

  443.           <td>(</td>
    444. 

  444.           <td class="paramtype"><a class="el" href="struct___i_f_a_p_i___o_b_j_e_c_t.html">IFAPI_OBJECT</a> *&#160;</td>
    445. 

  445.           <td class="paramname"><em>dest</em>, </td>
    446. 

  446.         </tr>
    447. 

  447.         <tr>
    448. 

  448.           <td class="paramkey"></td>
    449. 

  449.           <td></td>
    450. 

  450.           <td class="paramtype">const <a class="el" href="struct___i_f_a_p_i___o_b_j_e_c_t.html">IFAPI_OBJECT</a> *&#160;</td>
    451. 

  451.           <td class="paramname"><em>src</em>&#160;</td>
    452. 

  452.         </tr>
    453. 

  453.         <tr>
    454. 

  454.           <td></td>
    455. 

  455.           <td>)</td>
    456. 

  456.           <td></td><td></td>
    457. 

  457.         </tr>
    458. 

  458.       </table>
    459. 

  459. </div><div class="memdoc">
    460. 

  460. <p>Create a copy of a an ifapi object storing a key.</p>
    461. 

  461. <p>The key together with the policy of the key will be copied.</p>
    462. 

  462. <dl class="params"><dt>Parameters</dt><dd>
    463. 

  463.   <table class="params">
    464. 

  464.     <tr><td class="paramdir">[out]</td><td class="paramname">dest</td><td>The caller allocated key object which will be the destination of the copy operation. </td></tr>
    465. 

  465.     <tr><td class="paramdir">[in]</td><td class="paramname">src</td><td>The source key.</td></tr>
    466. 

  466.   </table>
    467. 

  467.   </dd>
    468. 

  468. </dl>
    469. 

  469. <dl class="retval"><dt>Return values</dt><dd>
    470. 

  470.   <table class="retval">
    471. 

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

  472.     <tr><td class="paramname">TSS2_FAPI_RC_GENERAL_FAILURE</td><td>if the source is not of type key. </td></tr>
    473. 

  473.     <tr><td class="paramname">TSS2_FAPI_RC_BAD_REFERENCE</td><td>a invalid null pointer is passed. </td></tr>
    474. 

  474.     <tr><td class="paramname">TSS2_FAPI_RC_MEMORY</td><td>if not enough memory can be allocated. </td></tr>
    475. 

  475.   </table>
    476. 

  476.   </dd>
    477. 

  477. </dl>
    478. 

  478. 

  479. </div>
    480. 

  480. </div>
    481. 

  481. <a id="ga6bb0e3d58d2c8644dfddb509bde5d09b"></a>
    482. 

  482. <h2 class="memtitle"><span class="permalink"><a href="#ga6bb0e3d58d2c8644dfddb509bde5d09b">&#9670;&nbsp;</a></span>ifapi_keystore_delete()</h2>
    483. 

  483. 

  484. <div class="memitem">
    485. 

  485. <div class="memproto">
    486. 

  486.       <table class="memname">
    487. 

  487.         <tr>
    488. 

  488.           <td class="memname">TSS2_RC ifapi_keystore_delete </td>
    489. 

  489.           <td>(</td>
    490. 

  490.           <td class="paramtype"><a class="el" href="struct_i_f_a_p_i___k_e_y_s_t_o_r_e.html">IFAPI_KEYSTORE</a> *&#160;</td>
    491. 

  491.           <td class="paramname"><em>keystore</em>, </td>
    492. 

  492.         </tr>
    493. 

  493.         <tr>
    494. 

  494.           <td class="paramkey"></td>
    495. 

  495.           <td></td>
    496. 

  496.           <td class="paramtype">char *&#160;</td>
    497. 

  497.           <td class="paramname"><em>path</em>&#160;</td>
    498. 

  498.         </tr>
    499. 

  499.         <tr>
    500. 

  500.           <td></td>
    501. 

  501.           <td>)</td>
    502. 

  502.           <td></td><td></td>
    503. 

  503.         </tr>
    504. 

  504.       </table>
    505. 

  505. </div><div class="memdoc">
    506. 

  506. <p>Remove file storing a keystore object.</p>
    507. 

  507. <dl class="params"><dt>Parameters</dt><dd>
    508. 

  508.   <table class="params">
    509. 

  509.     <tr><td class="paramdir">[in]</td><td class="paramname">keystore</td><td>The key directories, the default profile. </td></tr>
    510. 

  510.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>The relative name of the object be removed. </td></tr>
    511. 

  511.   </table>
    512. 

  512.   </dd>
    513. 

  513. </dl>
    514. 

  514. <dl class="retval"><dt>Return values</dt><dd>
    515. 

  515.   <table class="retval">
    516. 

  516.     <tr><td class="paramname">TSS2_RC_SUCCESS</td><td>On success. </td></tr>
    517. 

  517.     <tr><td class="paramname">TSS2_FAPI_RC_MEMORY</td><td>If memory could not be allocated. </td></tr>
    518. 

  518.     <tr><td class="paramname">TSS2_FAPI_RC_IO_ERROR</td><td>If the file can't be removed. </td></tr>
    519. 

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

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

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

  522.     <tr><td class="paramname">TSS2_FAPI_RC_NOT_PROVISIONED</td><td>FAPI was not provisioned. </td></tr>
    523. 

  523.     <tr><td class="paramname">TSS2_FAPI_RC_BAD_REFERENCE</td><td>a invalid null pointer is passed. </td></tr>
    524. 

  524.     <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>
    525. 

  525.   </table>
    526. 

  526.   </dd>
    527. 

  527. </dl>
    528. 

  528. 

  529. </div>
    530. 

  530. </div>
    531. 

  531. <a id="ga7fe64f630dfab96d28d1206b36937003"></a>
    532. 

  532. <h2 class="memtitle"><span class="permalink"><a href="#ga7fe64f630dfab96d28d1206b36937003">&#9670;&nbsp;</a></span>ifapi_keystore_initialize()</h2>
    533. 

  533. 

  534. <div class="memitem">
    535. 

  535. <div class="memproto">
    536. 

  536.       <table class="memname">
    537. 

  537.         <tr>
    538. 

  538.           <td class="memname">TSS2_RC ifapi_keystore_initialize </td>
    539. 

  539.           <td>(</td>
    540. 

  540.           <td class="paramtype"><a class="el" href="struct_i_f_a_p_i___k_e_y_s_t_o_r_e.html">IFAPI_KEYSTORE</a> *&#160;</td>
    541. 

  541.           <td class="paramname"><em>keystore</em>, </td>
    542. 

  542.         </tr>
    543. 

  543.         <tr>
    544. 

  544.           <td class="paramkey"></td>
    545. 

  545.           <td></td>
    546. 

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

  547.           <td class="paramname"><em>config_systemdir</em>, </td>
    548. 

  548.         </tr>
    549. 

  549.         <tr>
    550. 

  550.           <td class="paramkey"></td>
    551. 

  551.           <td></td>
    552. 

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

  553.           <td class="paramname"><em>config_userdir</em>, </td>
    554. 

  554.         </tr>
    555. 

  555.         <tr>
    556. 

  556.           <td class="paramkey"></td>
    557. 

  557.           <td></td>
    558. 

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

  559.           <td class="paramname"><em>config_defaultprofile</em>&#160;</td>
    560. 

  560.         </tr>
    561. 

  561.         <tr>
    562. 

  562.           <td></td>
    563. 

  563.           <td>)</td>
    564. 

  564.           <td></td><td></td>
    565. 

  565.         </tr>
    566. 

  566.       </table>
    567. 

  567. </div><div class="memdoc">
    568. 

  568. <p>Store keystore parameters in the keystore context.</p>
    569. 

  569. <p>Also the user directory will be created if it does not exist.</p>
    570. 

  570. <dl class="params"><dt>Parameters</dt><dd>
    571. 

  571.   <table class="params">
    572. 

  572.     <tr><td class="paramdir">[out]</td><td class="paramname">keystore</td><td>The keystore to be initialized. </td></tr>
    573. 

  573.     <tr><td class="paramdir">[in]</td><td class="paramname">config_systemdir</td><td>The configured system directory. </td></tr>
    574. 

  574.     <tr><td class="paramdir">[in]</td><td class="paramname">config_userdir</td><td>The configured user directory. </td></tr>
    575. 

  575.     <tr><td class="paramdir">[in]</td><td class="paramname">config_defaultprofile</td><td>The configured profile.</td></tr>
    576. 

  576.   </table>
    577. 

  577.   </dd>
    578. 

  578. </dl>
    579. 

  579. <dl class="retval"><dt>Return values</dt><dd>
    580. 

  580.   <table class="retval">
    581. 

  581.     <tr><td class="paramname">TSS2_RC_SUCCESS</td><td>If the keystore can be initialized. </td></tr>
    582. 

  582.     <tr><td class="paramname">TSS2_FAPI_RC_IO_ERROR</td><td>If the user part of the keystore can't be initialized. </td></tr>
    583. 

  583.     <tr><td class="paramname">TSS2_FAPI_RC_MEMORY</td><td>if memory could not be allocated. </td></tr>
    584. 

  584.     <tr><td class="paramname">TSS2_FAPI_RC_BAD_PATH</td><td>if the home directory of the user cannot be determined. </td></tr>
    585. 

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

  586.   </table>
    587. 

  587.   </dd>
    588. 

  588. </dl>
    589. 

  589. 

  590. </div>
    591. 

  591. </div>
    592. 

  592. <a id="ga7fe0097564cb4663a92f39e1620fc293"></a>
    593. 

  593. <h2 class="memtitle"><span class="permalink"><a href="#ga7fe0097564cb4663a92f39e1620fc293">&#9670;&nbsp;</a></span>ifapi_keystore_list_all()</h2>
    594. 

  594. 

  595. <div class="memitem">
    596. 

  596. <div class="memproto">
    597. 

  597.       <table class="memname">
    598. 

  598.         <tr>
    599. 

  599.           <td class="memname">TSS2_RC ifapi_keystore_list_all </td>
    600. 

  600.           <td>(</td>
    601. 

  601.           <td class="paramtype"><a class="el" href="struct_i_f_a_p_i___k_e_y_s_t_o_r_e.html">IFAPI_KEYSTORE</a> *&#160;</td>
    602. 

  602.           <td class="paramname"><em>keystore</em>, </td>
    603. 

  603.         </tr>
    604. 

  604.         <tr>
    605. 

  605.           <td class="paramkey"></td>
    606. 

  606.           <td></td>
    607. 

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

  608.           <td class="paramname"><em>searchpath</em>, </td>
    609. 

  609.         </tr>
    610. 

  610.         <tr>
    611. 

  611.           <td class="paramkey"></td>
    612. 

  612.           <td></td>
    613. 

  613.           <td class="paramtype">char ***&#160;</td>
    614. 

  614.           <td class="paramname"><em>results</em>, </td>
    615. 

  615.         </tr>
    616. 

  616.         <tr>
    617. 

  617.           <td class="paramkey"></td>
    618. 

  618.           <td></td>
    619. 

  619.           <td class="paramtype">size_t *&#160;</td>
    620. 

  620.           <td class="paramname"><em>numresults</em>&#160;</td>
    621. 

  621.         </tr>
    622. 

  622.         <tr>
    623. 

  623.           <td></td>
    624. 

  624.           <td>)</td>
    625. 

  625.           <td></td><td></td>
    626. 

  626.         </tr>
    627. 

  627.       </table>
    628. 

  628. </div><div class="memdoc">
    629. 

  629. <p>Create a list of of objects in a certain search path.</p>
    630. 

  630. <p>A vector of relative paths will be computed.</p>
    631. 

  631. <dl class="params"><dt>Parameters</dt><dd>
    632. 

  632.   <table class="params">
    633. 

  633.     <tr><td class="paramdir">[in]</td><td class="paramname">keystore</td><td>The key directories, the default profile. </td></tr>
    634. 

  634.     <tr><td class="paramdir">[in]</td><td class="paramname">searchpath</td><td>The relative search path in key store. </td></tr>
    635. 

  635.     <tr><td class="paramdir">[out]</td><td class="paramname">results</td><td>The array with pointers to the relative object paths. </td></tr>
    636. 

  636.     <tr><td class="paramdir">[out]</td><td class="paramname">numresults</td><td>The number of found objects. </td></tr>
    637. 

  637.   </table>
    638. 

  638.   </dd>
    639. 

  639. </dl>
    640. 

  640. <dl class="retval"><dt>Return values</dt><dd>
    641. 

  641.   <table class="retval">
    642. 

  642.     <tr><td class="paramname">TSS2_RC_SUCCESS</td><td>on success. </td></tr>
    643. 

  643.     <tr><td class="paramname">TSS2_FAPI_RC_MEMORY</td><td>if memory could not be allocated. </td></tr>
    644. 

  644.     <tr><td class="paramname">TSS2_FAPI_RC_BAD_REFERENCE</td><td>a invalid null pointer is passed. </td></tr>
    645. 

  645.     <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>
    646. 

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

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

  648.   </table>
    649. 

  649.   </dd>
    650. 

  650. </dl>
    651. 

  651. 

  652. </div>
    653. 

  653. </div>
    654. 

  654. <a id="ga6af418f78dd03c860a428b14e0530213"></a>
    655. 

  655. <h2 class="memtitle"><span class="permalink"><a href="#ga6af418f78dd03c860a428b14e0530213">&#9670;&nbsp;</a></span>ifapi_keystore_load_async()</h2>
    656. 

  656. 

  657. <div class="memitem">
    658. 

  658. <div class="memproto">
    659. 

  659.       <table class="memname">
    660. 

  660.         <tr>
    661. 

  661.           <td class="memname">TSS2_RC ifapi_keystore_load_async </td>
    662. 

  662.           <td>(</td>
    663. 

  663.           <td class="paramtype"><a class="el" href="struct_i_f_a_p_i___k_e_y_s_t_o_r_e.html">IFAPI_KEYSTORE</a> *&#160;</td>
    664. 

  664.           <td class="paramname"><em>keystore</em>, </td>
    665. 

  665.         </tr>
    666. 

  666.         <tr>
    667. 

  667.           <td class="paramkey"></td>
    668. 

  668.           <td></td>
    669. 

  669.           <td class="paramtype"><a class="el" href="struct_i_f_a_p_i___i_o.html">IFAPI_IO</a> *&#160;</td>
    670. 

  670.           <td class="paramname"><em>io</em>, </td>
    671. 

  671.         </tr>
    672. 

  672.         <tr>
    673. 

  673.           <td class="paramkey"></td>
    674. 

  674.           <td></td>
    675. 

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

  676.           <td class="paramname"><em>path</em>&#160;</td>
    677. 

  677.         </tr>
    678. 

  678.         <tr>
    679. 

  679.           <td></td>
    680. 

  680.           <td>)</td>
    681. 

  681.           <td></td><td></td>
    682. 

  682.         </tr>
    683. 

  683.       </table>
    684. 

  684. </div><div class="memdoc">
    685. 

  685. <p>Start loading FAPI object from key store.</p>
    686. 

  686. <p>Keys objects, NV objects, and hierarchies can be loaded.</p>
    687. 

  687. <dl class="params"><dt>Parameters</dt><dd>
    688. 

  688.   <table class="params">
    689. 

  689.     <tr><td class="paramdir">[in]</td><td class="paramname">keystore</td><td>The key directories and default profile. </td></tr>
    690. 

  690.     <tr><td class="paramdir">[in]</td><td class="paramname">io</td><td>The input/output context being used for file I/O. </td></tr>
    691. 

  691.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>The relative path of the object. For keys the path will expanded if possible. </td></tr>
    692. 

  692.   </table>
    693. 

  693.   </dd>
    694. 

  694. </dl>
    695. 

  695. <dl class="retval"><dt>Return values</dt><dd>
    696. 

  696.   <table class="retval">
    697. 

  697.     <tr><td class="paramname">TSS2_RC_SUCCESS</td><td>If the object can be read. </td></tr>
    698. 

  698.     <tr><td class="paramname">TSS2_FAPI_RC_IO_ERROR</td><td>if an I/O error was encountered. </td></tr>
    699. 

  699.     <tr><td class="paramname">TSS2_FAPI_RC_PATH_NOT_FOUND</td><td>if the file does not exist. </td></tr>
    700. 

  700.     <tr><td class="paramname">TSS2_FAPI_RC_MEMORY</td><td>if memory could not be allocated to hold the read data. </td></tr>
    701. 

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

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

  703.     <tr><td class="paramname">TSS2_FAPI_RC_NOT_PROVISIONED</td><td>FAPI was not provisioned. </td></tr>
    704. 

  704.     <tr><td class="paramname">TSS2_FAPI_RC_BAD_REFERENCE</td><td>a invalid null pointer is passed. </td></tr>
    705. 

  705.     <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>
    706. 

  706.   </table>
    707. 

  707.   </dd>
    708. 

  708. </dl>
    709. 

  709. 

  710. </div>
    711. 

  711. </div>
    712. 

  712. <a id="ga24d8a92700486782021c434be1865992"></a>
    713. 

  713. <h2 class="memtitle"><span class="permalink"><a href="#ga24d8a92700486782021c434be1865992">&#9670;&nbsp;</a></span>ifapi_keystore_object_does_not_exist()</h2>
    714. 

  714. 

  715. <div class="memitem">
    716. 

  716. <div class="memproto">
    717. 

  717.       <table class="memname">
    718. 

  718.         <tr>
    719. 

  719.           <td class="memname">ifapi_keystore_object_does_not_exist </td>
    720. 

  720.           <td>(</td>
    721. 

  721.           <td class="paramtype"><a class="el" href="struct_i_f_a_p_i___k_e_y_s_t_o_r_e.html">IFAPI_KEYSTORE</a> *&#160;</td>
    722. 

  722.           <td class="paramname"><em>keystore</em>, </td>
    723. 

  723.         </tr>
    724. 

  724.         <tr>
    725. 

  725.           <td class="paramkey"></td>
    726. 

  726.           <td></td>
    727. 

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

  728.           <td class="paramname"><em>path</em>, </td>
    729. 

  729.         </tr>
    730. 

  730.         <tr>
    731. 

  731.           <td class="paramkey"></td>
    732. 

  732.           <td></td>
    733. 

  733.           <td class="paramtype">const <a class="el" href="struct___i_f_a_p_i___o_b_j_e_c_t.html">IFAPI_OBJECT</a> *&#160;</td>
    734. 

  734.           <td class="paramname"><em>object</em>&#160;</td>
    735. 

  735.         </tr>
    736. 

  736.         <tr>
    737. 

  737.           <td></td>
    738. 

  738.           <td>)</td>
    739. 

  739.           <td></td><td></td>
    740. 

  740.         </tr>
    741. 

  741.       </table>
    742. 

  742. </div><div class="memdoc">
    743. 

  743. <p>Check whether the key path for a new object does not exist in key store.</p>
    744. 

  744. <p>To prevent overwriting of objects the functions returns an error if the object is already stored in key store. The FAPI path will be expanded to absolute path appropriate for the object to be checked.</p>
    745. 

  745. <dl class="params"><dt>Parameters</dt><dd>
    746. 

  746.   <table class="params">
    747. 

  747.     <tr><td class="paramdir">[in]</td><td class="paramname">keystore</td><td>The key directories and default profile. </td></tr>
    748. 

  748.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>The relative path of the object. For keys the path will expanded if possible. </td></tr>
    749. 

  749.     <tr><td class="paramdir">[in]</td><td class="paramname">object</td><td>The object to be checked. </td></tr>
    750. 

  750.   </table>
    751. 

  751.   </dd>
    752. 

  752. </dl>
    753. 

  753. <dl class="retval"><dt>Return values</dt><dd>
    754. 

  754.   <table class="retval">
    755. 

  755.     <tr><td class="paramname">TSS2_RC_SUCCESS</td><td>if the object does not exist and a new object can be written. </td></tr>
    756. 

  756.     <tr><td class="paramname">TSS2_FAPI_RC_PATH_ALREADY_EXISTS</td><td>if the object exists in key store. </td></tr>
    757. 

  757.     <tr><td class="paramname">TSS2_FAPI_RC_MEMORY</td><td>if memory could not be allocated to hold the output data. </td></tr>
    758. 

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

  759.     <tr><td class="paramname">TSS2_FAPI_RC_BAD_REFERENCE</td><td>a invalid null pointer is passed. </td></tr>
    760. 

  760.     <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>
    761. 

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

  762.   </table>
    763. 

  763.   </dd>
    764. 

  764. </dl>
    765. 

  765. 

  766. </div>
    767. 

  767. </div>
    768. 

  768. <a id="ga6c893408be4f545cf9c056284e3eab28"></a>
    769. 

  769. <h2 class="memtitle"><span class="permalink"><a href="#ga6c893408be4f545cf9c056284e3eab28">&#9670;&nbsp;</a></span>ifapi_keystore_remove_directories()</h2>
    770. 

  770. 

  771. <div class="memitem">
    772. 

  772. <div class="memproto">
    773. 

  773.       <table class="memname">
    774. 

  774.         <tr>
    775. 

  775.           <td class="memname">TSS2_RC ifapi_keystore_remove_directories </td>
    776. 

  776.           <td>(</td>
    777. 

  777.           <td class="paramtype"><a class="el" href="struct_i_f_a_p_i___k_e_y_s_t_o_r_e.html">IFAPI_KEYSTORE</a> *&#160;</td>
    778. 

  778.           <td class="paramname"><em>keystore</em>, </td>
    779. 

  779.         </tr>
    780. 

  780.         <tr>
    781. 

  781.           <td class="paramkey"></td>
    782. 

  782.           <td></td>
    783. 

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

  784.           <td class="paramname"><em>dir_name</em>&#160;</td>
    785. 

  785.         </tr>
    786. 

  786.         <tr>
    787. 

  787.           <td></td>
    788. 

  788.           <td>)</td>
    789. 

  789.           <td></td><td></td>
    790. 

  790.         </tr>
    791. 

  791.       </table>
    792. 

  792. </div><div class="memdoc">
    793. 

  793. <p>Remove directories in keystore.</p>
    794. 

  794. <p>If the expanded directory exists in userdir and systemdir both will be deleted.</p>
    795. 

  795. <dl class="params"><dt>Parameters</dt><dd>
    796. 

  796.   <table class="params">
    797. 

  797.     <tr><td class="paramdir">[in]</td><td class="paramname">keystore</td><td>The key directories, the default profile. </td></tr>
    798. 

  798.     <tr><td class="paramdir">[in]</td><td class="paramname">dir_name</td><td>The relative name of the directory to be removed. </td></tr>
    799. 

  799.   </table>
    800. 

  800.   </dd>
    801. 

  801. </dl>
    802. 

  802. <dl class="retval"><dt>Return values</dt><dd>
    803. 

  803.   <table class="retval">
    804. 

  804.     <tr><td class="paramname">TSS2_RC_SUCCESS</td><td>on success. </td></tr>
    805. 

  805.     <tr><td class="paramname">TSS2_FAPI_RC_MEMORY</td><td>If memory could not be allocated. </td></tr>
    806. 

  806.     <tr><td class="paramname">TSS2_FAPI_RC_IO_ERROR</td><td>If directory can't be deleted. </td></tr>
    807. 

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

  808.     <tr><td class="paramname">TSS2_FAPI_RC_BAD_REFERENCE</td><td>a invalid null pointer is passed. </td></tr>
    809. 

  809.     <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>
    810. 

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

  811.   </table>
    812. 

  812.   </dd>
    813. 

  813. </dl>
    814. 

  814. 

  815. </div>
    816. 

  816. </div>
    817. 

  817. <a id="ga6ecdfa3a0394f1e2ef0c9bf81039ed81"></a>
    818. 

  818. <h2 class="memtitle"><span class="permalink"><a href="#ga6ecdfa3a0394f1e2ef0c9bf81039ed81">&#9670;&nbsp;</a></span>ifapi_keystore_search_nv_obj()</h2>
    819. 

  819. 

  820. <div class="memitem">
    821. 

  821. <div class="memproto">
    822. 

  822.       <table class="memname">
    823. 

  823.         <tr>
    824. 

  824.           <td class="memname">TSS2_RC ifapi_keystore_search_nv_obj </td>
    825. 

  825.           <td>(</td>
    826. 

  826.           <td class="paramtype"><a class="el" href="struct_i_f_a_p_i___k_e_y_s_t_o_r_e.html">IFAPI_KEYSTORE</a> *&#160;</td>
    827. 

  827.           <td class="paramname"><em>keystore</em>, </td>
    828. 

  828.         </tr>
    829. 

  829.         <tr>
    830. 

  830.           <td class="paramkey"></td>
    831. 

  831.           <td></td>
    832. 

  832.           <td class="paramtype"><a class="el" href="struct_i_f_a_p_i___i_o.html">IFAPI_IO</a> *&#160;</td>
    833. 

  833.           <td class="paramname"><em>io</em>, </td>
    834. 

  834.         </tr>
    835. 

  835.         <tr>
    836. 

  836.           <td class="paramkey"></td>
    837. 

  837.           <td></td>
    838. 

  838.           <td class="paramtype">TPM2B_NV_PUBLIC *&#160;</td>
    839. 

  839.           <td class="paramname"><em>nv_public</em>, </td>
    840. 

  840.         </tr>
    841. 

  841.         <tr>
    842. 

  842.           <td class="paramkey"></td>
    843. 

  843.           <td></td>
    844. 

  844.           <td class="paramtype">char **&#160;</td>
    845. 

  845.           <td class="paramname"><em>found_path</em>&#160;</td>
    846. 

  846.         </tr>
    847. 

  847.         <tr>
    848. 

  848.           <td></td>
    849. 

  849.           <td>)</td>
    850. 

  850.           <td></td><td></td>
    851. 

  851.         </tr>
    852. 

  852.       </table>
    853. 

  853. </div><div class="memdoc">
    854. 

  854. <p>Search nv object with a certain nv_index (from nv_public) in keystore.</p>
    855. 

  855. <dl class="params"><dt>Parameters</dt><dd>
    856. 

  856.   <table class="params">
    857. 

  857.     <tr><td class="paramdir">[in,out]</td><td class="paramname">keystore</td><td>The key directories, the default profile, and the state information for the asynchronous search. </td></tr>
    858. 

  858.     <tr><td class="paramdir">[in]</td><td class="paramname">io</td><td>The input/output context being used for file I/O. </td></tr>
    859. 

  859.     <tr><td class="paramdir">[in]</td><td class="paramname">nv_public</td><td>The public data of the searched nv object. </td></tr>
    860. 

  860.     <tr><td class="paramdir">[out]</td><td class="paramname">found_path</td><td>The relative path of the found key. </td></tr>
    861. 

  861.   </table>
    862. 

  862.   </dd>
    863. 

  863. </dl>
    864. 

  864. <dl class="retval"><dt>Return values</dt><dd>
    865. 

  865.   <table class="retval">
    866. 

  866.     <tr><td class="paramname">TSS2_RC_SUCCESS</td><td>on success. </td></tr>
    867. 

  867.     <tr><td class="paramname">TSS2_FAPI_RC_MEMORY</td><td>if memory could not be allocated. </td></tr>
    868. 

  868.     <tr><td class="paramname">TSS2_FAPI_RC_KEY_NOT_FOUND</td><td>If the key was not found in keystore. </td></tr>
    869. 

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

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

  871.     <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>
    872. 

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

  873.     <tr><td class="paramname">TSS2_FAPI_RC_IO_ERROR</td><td>if an error occurred while accessing the object store. </td></tr>
    874. 

  874.     <tr><td class="paramname">TSS2_FAPI_RC_GENERAL_FAILURE</td><td>if an internal error occurred. </td></tr>
    875. 

  875.     <tr><td class="paramname">TSS2_FAPI_RC_BAD_REFERENCE</td><td>a invalid null pointer is passed. </td></tr>
    876. 

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

  877.     <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>
    878. 

  878.     <tr><td class="paramname">TSS2_FAPI_RC_NOT_PROVISIONED</td><td>FAPI was not provisioned. </td></tr>
    879. 

  879.   </table>
    880. 

  880.   </dd>
    881. 

  881. </dl>
    882. 

  882. 

  883. </div>
    884. 

  884. </div>
    885. 

  885. <a id="ga26224646067aa6f2e349a43345744fd5"></a>
    886. 

  886. <h2 class="memtitle"><span class="permalink"><a href="#ga26224646067aa6f2e349a43345744fd5">&#9670;&nbsp;</a></span>ifapi_keystore_search_obj()</h2>
    887. 

  887. 

  888. <div class="memitem">
    889. 

  889. <div class="memproto">
    890. 

  890.       <table class="memname">
    891. 

  891.         <tr>
    892. 

  892.           <td class="memname">TSS2_RC ifapi_keystore_search_obj </td>
    893. 

  893.           <td>(</td>
    894. 

  894.           <td class="paramtype"><a class="el" href="struct_i_f_a_p_i___k_e_y_s_t_o_r_e.html">IFAPI_KEYSTORE</a> *&#160;</td>
    895. 

  895.           <td class="paramname"><em>keystore</em>, </td>
    896. 

  896.         </tr>
    897. 

  897.         <tr>
    898. 

  898.           <td class="paramkey"></td>
    899. 

  899.           <td></td>
    900. 

  900.           <td class="paramtype"><a class="el" href="struct_i_f_a_p_i___i_o.html">IFAPI_IO</a> *&#160;</td>
    901. 

  901.           <td class="paramname"><em>io</em>, </td>
    902. 

  902.         </tr>
    903. 

  903.         <tr>
    904. 

  904.           <td class="paramkey"></td>
    905. 

  905.           <td></td>
    906. 

  906.           <td class="paramtype">TPM2B_NAME *&#160;</td>
    907. 

  907.           <td class="paramname"><em>name</em>, </td>
    908. 

  908.         </tr>
    909. 

  909.         <tr>
    910. 

  910.           <td class="paramkey"></td>
    911. 

  911.           <td></td>
    912. 

  912.           <td class="paramtype">char **&#160;</td>
    913. 

  913.           <td class="paramname"><em>found_path</em>&#160;</td>
    914. 

  914.         </tr>
    915. 

  915.         <tr>
    916. 

  916.           <td></td>
    917. 

  917.           <td>)</td>
    918. 

  918.           <td></td><td></td>
    919. 

  919.         </tr>
    920. 

  920.       </table>
    921. 

  921. </div><div class="memdoc">
    922. 

  922. <p>Search object with a certain name in keystore.</p>
    923. 

  923. <dl class="params"><dt>Parameters</dt><dd>
    924. 

  924.   <table class="params">
    925. 

  925.     <tr><td class="paramdir">[in,out]</td><td class="paramname">keystore</td><td>The key directories, the default profile, and the state information for the asynchronous search. </td></tr>
    926. 

  926.     <tr><td class="paramdir">[in]</td><td class="paramname">io</td><td>The input/output context being used for file I/O. </td></tr>
    927. 

  927.     <tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>The name of the searched object. </td></tr>
    928. 

  928.     <tr><td class="paramdir">[out]</td><td class="paramname">found_path</td><td>The relative path of the found key. </td></tr>
    929. 

  929.   </table>
    930. 

  930.   </dd>
    931. 

  931. </dl>
    932. 

  932. <dl class="retval"><dt>Return values</dt><dd>
    933. 

  933.   <table class="retval">
    934. 

  934.     <tr><td class="paramname">TSS2_RC_SUCCESS</td><td>on success. </td></tr>
    935. 

  935.     <tr><td class="paramname">TSS2_FAPI_RC_MEMORY</td><td>if memory could not be allocated. </td></tr>
    936. 

  936.     <tr><td class="paramname">TSS2_FAPI_RC_KEY_NOT_FOUND</td><td>If the key was not found in keystore. </td></tr>
    937. 

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

  938.     <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>
    939. 

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

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

  941.     <tr><td class="paramname">TSS2_FAPI_RC_IO_ERROR</td><td>if an error occurred while accessing the object store. </td></tr>
    942. 

  942.     <tr><td class="paramname">TSS2_FAPI_RC_GENERAL_FAILURE</td><td>if an internal error occurred. </td></tr>
    943. 

  943.     <tr><td class="paramname">TSS2_FAPI_RC_BAD_REFERENCE</td><td>a invalid null pointer is passed. </td></tr>
    944. 

  944.     <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>
    945. 

  945.     <tr><td class="paramname">TSS2_FAPI_RC_NOT_PROVISIONED</td><td>FAPI was not provisioned. </td></tr>
    946. 

  946.   </table>
    947. 

  947.   </dd>
    948. 

  948. </dl>
    949. 

  949. 

  950. </div>
    951. 

  951. </div>
    952. 

  952. <a id="gaf8394ad181ae3e9130c4aec886cb091d"></a>
    953. 

  953. <h2 class="memtitle"><span class="permalink"><a href="#gaf8394ad181ae3e9130c4aec886cb091d">&#9670;&nbsp;</a></span>ifapi_keystore_store_async()</h2>
    954. 

  954. 

  955. <div class="memitem">
    956. 

  956. <div class="memproto">
    957. 

  957.       <table class="memname">
    958. 

  958.         <tr>
    959. 

  959.           <td class="memname">TSS2_RC ifapi_keystore_store_async </td>
    960. 

  960.           <td>(</td>
    961. 

  961.           <td class="paramtype"><a class="el" href="struct_i_f_a_p_i___k_e_y_s_t_o_r_e.html">IFAPI_KEYSTORE</a> *&#160;</td>
    962. 

  962.           <td class="paramname"><em>keystore</em>, </td>
    963. 

  963.         </tr>
    964. 

  964.         <tr>
    965. 

  965.           <td class="paramkey"></td>
    966. 

  966.           <td></td>
    967. 

  967.           <td class="paramtype"><a class="el" href="struct_i_f_a_p_i___i_o.html">IFAPI_IO</a> *&#160;</td>
    968. 

  968.           <td class="paramname"><em>io</em>, </td>
    969. 

  969.         </tr>
    970. 

  970.         <tr>
    971. 

  971.           <td class="paramkey"></td>
    972. 

  972.           <td></td>
    973. 

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

  974.           <td class="paramname"><em>path</em>, </td>
    975. 

  975.         </tr>
    976. 

  976.         <tr>
    977. 

  977.           <td class="paramkey"></td>
    978. 

  978.           <td></td>
    979. 

  979.           <td class="paramtype">const <a class="el" href="struct___i_f_a_p_i___o_b_j_e_c_t.html">IFAPI_OBJECT</a> *&#160;</td>
    980. 

  980.           <td class="paramname"><em>object</em>&#160;</td>
    981. 

  981.         </tr>
    982. 

  982.         <tr>
    983. 

  983.           <td></td>
    984. 

  984.           <td>)</td>
    985. 

  985.           <td></td><td></td>
    986. 

  986.         </tr>
    987. 

  987.       </table>
    988. 

  988. </div><div class="memdoc">
    989. 

  989. <p>Start writing FAPI object to the key store.</p>
    990. 

  990. <p>Keys objects, NV objects, and hierarchies can be written.</p>
    991. 

  991. <dl class="params"><dt>Parameters</dt><dd>
    992. 

  992.   <table class="params">
    993. 

  993.     <tr><td class="paramdir">[in]</td><td class="paramname">keystore</td><td>The key directories and default profile. </td></tr>
    994. 

  994.     <tr><td class="paramdir">[in]</td><td class="paramname">io</td><td>The input/output context being used for file I/O. </td></tr>
    995. 

  995.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>The relative path of the object. For keys the path will expanded if possible. </td></tr>
    996. 

  996.     <tr><td class="paramdir">[in]</td><td class="paramname">object</td><td>The object to be written to the keystore. </td></tr>
    997. 

  997.   </table>
    998. 

  998.   </dd>
    999. 

  999. </dl>
    1000. 

  1000. <dl class="retval"><dt>Return values</dt><dd>
    1001. 

  1001.   <table class="retval">
    1002. 

  1002.     <tr><td class="paramname">TSS2_RC_SUCCESS</td><td>if the object is written successfully. </td></tr>
    1003. 

  1003.     <tr><td class="paramname">TSS2_FAPI_RC_IO_ERROR</td><td>if an I/O error was encountered; </td></tr>
    1004. 

  1004.     <tr><td class="paramname">TSS2_FAPI_RC_MEMORY</td><td>if memory could not be allocated to hold the output data. </td></tr>
    1005. 

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

  1006.     <tr><td class="paramname">TSS2_FAPI_RC_GENERAL_FAILURE</td><td>if an internal error occurred. </td></tr>
    1007. 

  1007.     <tr><td class="paramname">TSS2_FAPI_RC_BAD_REFERENCE</td><td>a invalid null pointer is passed. </td></tr>
    1008. 

  1008.     <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>
    1009. 

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

  1010.   </table>
    1011. 

  1011.   </dd>
    1012. 

  1012. </dl>
    1013. 

  1013. 

  1014. </div>
    1015. 

  1015. </div>
    1016. 

  1016. </div><!-- contents -->
    1017. 

  1017. </div><!-- doc-content -->
    1018. 

  1018. <!-- start footer part -->
    1019. 

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

  1020.   <ul>
    1021. 

  1021.     <li class="footer">Generated by
    1022. 

  1022.     <a href="http://www.doxygen.org/index.html">
    1023. 

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

  1024.   </ul>
    1025. 

  1025. </div>
    1026. 

  1026. </body>
    1027. 

  1027. </html>
    1028.