onnxruntime/docs/api/c/struct_ort_api_base.html

163 lines
8.7 KiB
HTML
Raw Normal View History

<!-- HTML header for doxygen 1.9.2-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>OnnxRuntime: OrtApiBase Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-156955408-1"></script><script type="text/javascript">"use strict"; window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'UA-156955408-1'); </script> <script type="text/javascript" src="/assets/js/vendor/lunr.min.js"></script> <script type="text/javascript" src="/assets/js/just-the-docs.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="ONNX_Runtime_logo - Docs.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">OnnxRuntime
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.2 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('struct_ort_api_base.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="struct_ort_api_base-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">OrtApiBase Struct Reference<div class="ingroups"><a class="el" href="group___global.html">Global</a></div></div></div>
</div><!--header-->
<div class="contents">
<p>The helper interface to get the right version of <a class="el" href="struct_ort_api.html" title="The C API.">OrtApi</a>.
<a href="struct_ort_api_base.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="onnxruntime__c__api_8h_source.html">onnxruntime_c_api.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:ae031126e31871e4ad58ba1a647a2c9f9"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="struct_ort_api.html">OrtApi</a> *(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_ort_api_base.html#ae031126e31871e4ad58ba1a647a2c9f9">GetApi</a> )(uint32_t version)</td></tr>
<tr class="memdesc:ae031126e31871e4ad58ba1a647a2c9f9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a pointer to the requested version of the <a class="el" href="struct_ort_api.html" title="The C API.">OrtApi</a>. <a href="struct_ort_api_base.html#ae031126e31871e4ad58ba1a647a2c9f9">More...</a><br /></td></tr>
<tr class="separator:ae031126e31871e4ad58ba1a647a2c9f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a526ca6b93c227df319c4730974199e59"><td class="memItemLeft" align="right" valign="top">const char *(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_ort_api_base.html#a526ca6b93c227df319c4730974199e59">GetVersionString</a> )(void)</td></tr>
<tr class="memdesc:a526ca6b93c227df319c4730974199e59"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a null terminated string of the version of the Onnxruntime library (eg: "1.8.1") <a href="struct_ort_api_base.html#a526ca6b93c227df319c4730974199e59">More...</a><br /></td></tr>
<tr class="separator:a526ca6b93c227df319c4730974199e59"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p >The helper interface to get the right version of <a class="el" href="struct_ort_api.html" title="The C API.">OrtApi</a>. </p>
<p >Get a pointer to this structure through <a class="el" href="group___global.html#gaff6ff297798b9337d4c0f89a35b76aa6" title="The Onnxruntime library&#39;s entry point to access the C API.">OrtGetApiBase</a> </p>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a id="ae031126e31871e4ad58ba1a647a2c9f9" name="ae031126e31871e4ad58ba1a647a2c9f9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae031126e31871e4ad58ba1a647a2c9f9">&#9670;&nbsp;</a></span>GetApi</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="struct_ort_api.html">OrtApi</a> *( * OrtApiBase::GetApi) (uint32_t version)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a pointer to the requested version of the <a class="el" href="struct_ort_api.html" title="The C API.">OrtApi</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">version</td><td>Must be <a class="el" href="group___global.html#gac583aeb4640621ceb588f6300537945d" title="The API version defined in this header.">ORT_API_VERSION</a> </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The <a class="el" href="struct_ort_api.html" title="The C API.">OrtApi</a> for the version requested, nullptr will be returned if this version is unsupported, for example when using a runtime older than the version created with this header file. </dd></dl>
</div>
</div>
<a id="a526ca6b93c227df319c4730974199e59" name="a526ca6b93c227df319c4730974199e59"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a526ca6b93c227df319c4730974199e59">&#9670;&nbsp;</a></span>GetVersionString</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char *( * OrtApiBase::GetVersionString) (void)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a null terminated string of the version of the Onnxruntime library (eg: "1.8.1") </p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="struct_ort_api_base.html">OrtApiBase</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.2 </li>
</ul>
</div>
</body>
</html>