AI/rocm-systems
2
0
Fork 0
Code Issues Pull-Requests Actions Pakete Projekte Releases Wiki Aktivität
Dateien
ba9ad6be805addac662e1f46f4ce80bcb5da820b
rocm-systems/docs/RuntimeAPI/html/group__Error.html
T

206 Zeilen
14 KiB
HTML
Originalformat Normale Ansicht Verlauf

Initial commit for GPUOpen Launch
2016-01-26 20:14:33 -06:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>HIP: Heterogenous-computing Interface for Portability: Error Handling</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</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 style="padding-left: 0.5em;">
<div id="projectname">HIP: Heterogenous-computing Interface for Portability
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Pages</a></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="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Error Handling<div class="ingroups"><a class="el" href="group__API.html">HIP API</a></div></div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga533daeb9114d7fc2db8d867adf9e419b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Error.html#ga533daeb9114d7fc2db8d867adf9e419b">hipGetLastError</a> (void)</td></tr>
<tr class="memdesc:ga533daeb9114d7fc2db8d867adf9e419b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return last error returned by any HIP runtime API call and resets the stored error code to <a class="el" href="group__GlobalDefs.html#ggadf5010f6e140a53ecbdf949e73e87594aadfbdb847b149723c684ebd764556063" title="Successful completion. ">hipSuccess</a>. <a href="#ga533daeb9114d7fc2db8d867adf9e419b">More...</a><br/></td></tr>
<tr class="separator:ga533daeb9114d7fc2db8d867adf9e419b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1dd660bc739f7e13edd34615660f0148"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Error.html#ga1dd660bc739f7e13edd34615660f0148">hipPeekAtLastError</a> (void)</td></tr>
<tr class="memdesc:ga1dd660bc739f7e13edd34615660f0148"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return last error returned by any HIP runtime API call. <a href="#ga1dd660bc739f7e13edd34615660f0148">More...</a><br/></td></tr>
<tr class="separator:ga1dd660bc739f7e13edd34615660f0148"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga88c474d77635523dbf6ca67be7b56999"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Error.html#ga88c474d77635523dbf6ca67be7b56999">hipGetErrorName</a> (<a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a> hip_error)</td></tr>
<tr class="memdesc:ga88c474d77635523dbf6ca67be7b56999"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return name of the specified error code in text form. <a href="#ga88c474d77635523dbf6ca67be7b56999">More...</a><br/></td></tr>
<tr class="separator:ga88c474d77635523dbf6ca67be7b56999"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5959779a654bbc98ffe6d36ab536740a"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Error.html#ga5959779a654bbc98ffe6d36ab536740a">hipGetErrorString</a> (<a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a> hip_error)</td></tr>
<tr class="memdesc:ga5959779a654bbc98ffe6d36ab536740a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return handy text string message to explain the error which occurred. <a href="#ga5959779a654bbc98ffe6d36ab536740a">More...</a><br/></td></tr>
<tr class="separator:ga5959779a654bbc98ffe6d36ab536740a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2>----------------------------------------------------------------------------------------------&mdash; </h2>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga88c474d77635523dbf6ca67be7b56999"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* hipGetErrorName </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a>&#160;</td>
<td class="paramname"><em>hip_error</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return name of the specified error code in text form. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">hip_error</td><td>Error code to convert to name. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>const char pointer to the NULL-terminated error name</dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__Error.html#ga5959779a654bbc98ffe6d36ab536740a" title="Return handy text string message to explain the error which occurred. ">hipGetErrorString</a>, <a class="el" href="group__Error.html#ga533daeb9114d7fc2db8d867adf9e419b" title="Return last error returned by any HIP runtime API call and resets the stored error code to hipSuccess...">hipGetLastError</a>, hipPeakAtLastError, <a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga5959779a654bbc98ffe6d36ab536740a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* hipGetErrorString </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a>&#160;</td>
<td class="paramname"><em>hip_error</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return handy text string message to explain the error which occurred. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">hip_error</td><td>Error code to convert to string. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>const char pointer to the NULL-terminated error string</dd></dl>
<dl class="section warning"><dt>Warning</dt><dd>: on HCC, this function returns the name of the error (same as hipGetErrorName)</dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__Error.html#ga88c474d77635523dbf6ca67be7b56999" title="Return name of the specified error code in text form. ">hipGetErrorName</a>, <a class="el" href="group__Error.html#ga533daeb9114d7fc2db8d867adf9e419b" title="Return last error returned by any HIP runtime API call and resets the stored error code to hipSuccess...">hipGetLastError</a>, hipPeakAtLastError, <a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a></dd></dl>
<dl class="section warning"><dt>Warning</dt><dd>: hipGetErrorString returns string from hipGetErrorName </dd></dl>
</div>
</div>
<a class="anchor" id="ga533daeb9114d7fc2db8d867adf9e419b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a> hipGetLastError </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return last error returned by any HIP runtime API call and resets the stored error code to <a class="el" href="group__GlobalDefs.html#ggadf5010f6e140a53ecbdf949e73e87594aadfbdb847b149723c684ebd764556063" title="Successful completion. ">hipSuccess</a>. </p>
<p>Returns the last error that has been returned by any of the runtime calls in the same host thread, and then resets the saved error to <a class="el" href="group__GlobalDefs.html#ggadf5010f6e140a53ecbdf949e73e87594aadfbdb847b149723c684ebd764556063" title="Successful completion. ">hipSuccess</a>.</p>
<dl class="section return"><dt>Returns</dt><dd>return code from last HIP called from the active host thread. </dd></dl>
</div>
</div>
<a class="anchor" id="ga1dd660bc739f7e13edd34615660f0148"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a> hipPeekAtLastError </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return last error returned by any HIP runtime API call. </p>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__GlobalDefs.html#ggadf5010f6e140a53ecbdf949e73e87594aadfbdb847b149723c684ebd764556063" title="Successful completion. ">hipSuccess</a></dd></dl>
<p>Returns the last error that has been returned by any of the runtime calls in the same host thread. Unlike hipGetLastError, this function does not reset the saved error code. </p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Update doxygen HTML
2016-02-18 20:43:03 -06:00
Generated on Thu Feb 18 2016 20:42:16 for HIP: Heterogenous-computing Interface for Portability by &#160;<a href="http://www.doxygen.org/index.html">
Initial commit for GPUOpen Launch
2016-01-26 20:14:33 -06:00
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>
In neuem Issue referenzieren Permalink kopieren