N64FlashcartMenu/cart__load_8h.html

218 lines
16 KiB
HTML
Raw Normal View History

<!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" lang="en-US">
<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.5"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>N64FlashcartMenu: cart_load.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="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 id="projectrow">
<td id="projectalign">
<div id="projectname">N64FlashcartMenu
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.5 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "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>
<!-- 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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_1a56cc8cdc1689899910be5fa4716ee4.html">menu</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">cart_load.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>ROM/save loading functions.
<a href="#details">More...</a></p>
<p><a href="cart__load_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a8fdf9a69cab967a2d76e575338b1c2e1"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="cart__load_8h.html#a8fdf9a69cab967a2d76e575338b1c2e1">cart_load_err_t</a> { <br />
&#160;&#160;<a class="el" href="cart__load_8h.html#a8fdf9a69cab967a2d76e575338b1c2e1aea31d0c75e127d10538672f956b0a97f">CART_LOAD_OK</a>
, <a class="el" href="cart__load_8h.html#a8fdf9a69cab967a2d76e575338b1c2e1a73957ef4ccf0260503bc268e8f4ca3a1">CART_LOAD_ERR_ROM_LOAD_FAIL</a>
, <a class="el" href="cart__load_8h.html#a8fdf9a69cab967a2d76e575338b1c2e1a0ddb2665a271110ce96727c18f73fc61">CART_LOAD_ERR_SAVE_LOAD_FAIL</a>
, <a class="el" href="cart__load_8h.html#a8fdf9a69cab967a2d76e575338b1c2e1a8e277b1b0166f4104b2e48cd80aab86f">CART_LOAD_ERR_64DD_PRESENT</a>
, <br />
&#160;&#160;<a class="el" href="cart__load_8h.html#a8fdf9a69cab967a2d76e575338b1c2e1a624bbf8456bf0287885f1fb38d109c27">CART_LOAD_ERR_64DD_IPL_NOT_FOUND</a>
, <a class="el" href="cart__load_8h.html#a8fdf9a69cab967a2d76e575338b1c2e1a0e5ec7fa832ffa086a072b89055e8ead">CART_LOAD_ERR_64DD_IPL_LOAD_FAIL</a>
, <a class="el" href="cart__load_8h.html#a8fdf9a69cab967a2d76e575338b1c2e1aa192e96811678f36f520e581f8d2ded6">CART_LOAD_ERR_64DD_DISK_LOAD_FAIL</a>
, <a class="el" href="cart__load_8h.html#a8fdf9a69cab967a2d76e575338b1c2e1a4c236648876e0652e917b53ddef20f45">CART_LOAD_ERR_EMU_NOT_FOUND</a>
, <br />
&#160;&#160;<a class="el" href="cart__load_8h.html#a8fdf9a69cab967a2d76e575338b1c2e1a5614f8fff9a2685697ce3aa122499da2">CART_LOAD_ERR_EMU_LOAD_FAIL</a>
, <b>CART_LOAD_ERR_EMU_ROM_LOAD_FAIL</b>
, <a class="el" href="cart__load_8h.html#a8fdf9a69cab967a2d76e575338b1c2e1aefad8c3079967d11ae9be1bd78d2098f">CART_LOAD_ERR_CREATE_SAVES_SUBDIR_FAIL</a>
, <a class="el" href="cart__load_8h.html#a8fdf9a69cab967a2d76e575338b1c2e1a56c5993cab82de5c3c9c495153295474">CART_LOAD_ERR_EXP_PAK_NOT_FOUND</a>
, <br />
&#160;&#160;<a class="el" href="cart__load_8h.html#a8fdf9a69cab967a2d76e575338b1c2e1aec87a2398fb3cda8b6a4dcc2bf6debde">CART_LOAD_ERR_FUNCTION_NOT_SUPPORTED</a>
<br />
}</td></tr>
<tr class="memdesc:a8fdf9a69cab967a2d76e575338b1c2e1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Cart load state enumeration. <a href="cart__load_8h.html#a8fdf9a69cab967a2d76e575338b1c2e1">More...</a><br /></td></tr>
<tr class="separator:a8fdf9a69cab967a2d76e575338b1c2e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abe82a7d601e4b10ab65184b8aebde2bf"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="cart__load_8h.html#abe82a7d601e4b10ab65184b8aebde2bf">cart_load_emu_type_t</a> { <br />
&#160;&#160;<a class="el" href="cart__load_8h.html#abe82a7d601e4b10ab65184b8aebde2bfa7d3d6237c3ba74a6f976f0fc960d2fc8">CART_LOAD_EMU_TYPE_NES</a>
, <a class="el" href="cart__load_8h.html#abe82a7d601e4b10ab65184b8aebde2bfa390aa1196d1fbec39236a891871de082">CART_LOAD_EMU_TYPE_SNES</a>
, <a class="el" href="cart__load_8h.html#abe82a7d601e4b10ab65184b8aebde2bfab0ff2ec231e699a01af2d0aa130a394d">CART_LOAD_EMU_TYPE_GAMEBOY</a>
, <a class="el" href="cart__load_8h.html#abe82a7d601e4b10ab65184b8aebde2bfa3395e659a0a25fd963691ff6288d4cf3">CART_LOAD_EMU_TYPE_GAMEBOY_COLOR</a>
, <br />
&#160;&#160;<a class="el" href="cart__load_8h.html#abe82a7d601e4b10ab65184b8aebde2bfa357930eb0490e5517270e57dbadbae66">CART_LOAD_EMU_TYPE_SEGA_GENERIC_8BIT</a>
<br />
}</td></tr>
<tr class="memdesc:abe82a7d601e4b10ab65184b8aebde2bf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Cart load type enumeration. <a href="cart__load_8h.html#abe82a7d601e4b10ab65184b8aebde2bf">More...</a><br /></td></tr>
<tr class="separator:abe82a7d601e4b10ab65184b8aebde2bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a15473e486e1aa6e4568c45040ae74426"><td class="memItemLeft" align="right" valign="top"><a id="a15473e486e1aa6e4568c45040ae74426" name="a15473e486e1aa6e4568c45040ae74426"></a>
char *&#160;</td><td class="memItemRight" valign="bottom"><b>cart_load_convert_error_message</b> (<a class="el" href="cart__load_8h.html#a8fdf9a69cab967a2d76e575338b1c2e1">cart_load_err_t</a> err)</td></tr>
<tr class="separator:a15473e486e1aa6e4568c45040ae74426"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9bd54bc6cd012de3156c5b7a649dfec3"><td class="memItemLeft" align="right" valign="top"><a id="a9bd54bc6cd012de3156c5b7a649dfec3" name="a9bd54bc6cd012de3156c5b7a649dfec3"></a>
<a class="el" href="cart__load_8h.html#a8fdf9a69cab967a2d76e575338b1c2e1">cart_load_err_t</a>&#160;</td><td class="memItemRight" valign="bottom"><b>cart_load_n64_rom_and_save</b> (<a class="el" href="menu__state_8h.html#structmenu__t">menu_t</a> *menu, flashcart_progress_callback_t progress)</td></tr>
<tr class="separator:a9bd54bc6cd012de3156c5b7a649dfec3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2812c219d9f2a935c42f1ffd8c05dc02"><td class="memItemLeft" align="right" valign="top"><a id="a2812c219d9f2a935c42f1ffd8c05dc02" name="a2812c219d9f2a935c42f1ffd8c05dc02"></a>
<a class="el" href="cart__load_8h.html#a8fdf9a69cab967a2d76e575338b1c2e1">cart_load_err_t</a>&#160;</td><td class="memItemRight" valign="bottom"><b>cart_load_64dd_ipl_and_disk</b> (<a class="el" href="menu__state_8h.html#structmenu__t">menu_t</a> *menu, flashcart_progress_callback_t progress)</td></tr>
<tr class="separator:a2812c219d9f2a935c42f1ffd8c05dc02"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae7ab3db0eb827664ec5251ced149615f"><td class="memItemLeft" align="right" valign="top"><a id="ae7ab3db0eb827664ec5251ced149615f" name="ae7ab3db0eb827664ec5251ced149615f"></a>
<a class="el" href="cart__load_8h.html#a8fdf9a69cab967a2d76e575338b1c2e1">cart_load_err_t</a>&#160;</td><td class="memItemRight" valign="bottom"><b>cart_load_emulator</b> (<a class="el" href="menu__state_8h.html#structmenu__t">menu_t</a> *menu, <a class="el" href="cart__load_8h.html#abe82a7d601e4b10ab65184b8aebde2bf">cart_load_emu_type_t</a> emu_type, flashcart_progress_callback_t progress)</td></tr>
<tr class="separator:ae7ab3db0eb827664ec5251ced149615f"><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 >ROM/save loading functions. </p>
</div><h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="a8fdf9a69cab967a2d76e575338b1c2e1" name="a8fdf9a69cab967a2d76e575338b1c2e1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8fdf9a69cab967a2d76e575338b1c2e1">&#9670;&#160;</a></span>cart_load_err_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="cart__load_8h.html#a8fdf9a69cab967a2d76e575338b1c2e1">cart_load_err_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Cart load state enumeration. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a8fdf9a69cab967a2d76e575338b1c2e1aea31d0c75e127d10538672f956b0a97f" name="a8fdf9a69cab967a2d76e575338b1c2e1aea31d0c75e127d10538672f956b0a97f"></a>CART_LOAD_OK&#160;</td><td class="fielddoc"><p >Returned no error. </p>
</td></tr>
<tr><td class="fieldname"><a id="a8fdf9a69cab967a2d76e575338b1c2e1a73957ef4ccf0260503bc268e8f4ca3a1" name="a8fdf9a69cab967a2d76e575338b1c2e1a73957ef4ccf0260503bc268e8f4ca3a1"></a>CART_LOAD_ERR_ROM_LOAD_FAIL&#160;</td><td class="fielddoc"><p >Failed to load the ROM correctly. </p>
</td></tr>
<tr><td class="fieldname"><a id="a8fdf9a69cab967a2d76e575338b1c2e1a0ddb2665a271110ce96727c18f73fc61" name="a8fdf9a69cab967a2d76e575338b1c2e1a0ddb2665a271110ce96727c18f73fc61"></a>CART_LOAD_ERR_SAVE_LOAD_FAIL&#160;</td><td class="fielddoc"><p >Failed to load the save correctly. </p>
</td></tr>
<tr><td class="fieldname"><a id="a8fdf9a69cab967a2d76e575338b1c2e1a8e277b1b0166f4104b2e48cd80aab86f" name="a8fdf9a69cab967a2d76e575338b1c2e1a8e277b1b0166f4104b2e48cd80aab86f"></a>CART_LOAD_ERR_64DD_PRESENT&#160;</td><td class="fielddoc"><p >The 64DD is available for use. </p>
</td></tr>
<tr><td class="fieldname"><a id="a8fdf9a69cab967a2d76e575338b1c2e1a624bbf8456bf0287885f1fb38d109c27" name="a8fdf9a69cab967a2d76e575338b1c2e1a624bbf8456bf0287885f1fb38d109c27"></a>CART_LOAD_ERR_64DD_IPL_NOT_FOUND&#160;</td><td class="fielddoc"><p >Failed to find the 64DD IPL (BIOS) file. </p>
</td></tr>
<tr><td class="fieldname"><a id="a8fdf9a69cab967a2d76e575338b1c2e1a0e5ec7fa832ffa086a072b89055e8ead" name="a8fdf9a69cab967a2d76e575338b1c2e1a0e5ec7fa832ffa086a072b89055e8ead"></a>CART_LOAD_ERR_64DD_IPL_LOAD_FAIL&#160;</td><td class="fielddoc"><p >Failed to load the 64DD IPL (BIOS) file. </p>
</td></tr>
<tr><td class="fieldname"><a id="a8fdf9a69cab967a2d76e575338b1c2e1aa192e96811678f36f520e581f8d2ded6" name="a8fdf9a69cab967a2d76e575338b1c2e1aa192e96811678f36f520e581f8d2ded6"></a>CART_LOAD_ERR_64DD_DISK_LOAD_FAIL&#160;</td><td class="fielddoc"><p >Failed to find the 64DD disk. </p>
</td></tr>
<tr><td class="fieldname"><a id="a8fdf9a69cab967a2d76e575338b1c2e1a4c236648876e0652e917b53ddef20f45" name="a8fdf9a69cab967a2d76e575338b1c2e1a4c236648876e0652e917b53ddef20f45"></a>CART_LOAD_ERR_EMU_NOT_FOUND&#160;</td><td class="fielddoc"><p >Failed to find the emulator required. </p>
</td></tr>
<tr><td class="fieldname"><a id="a8fdf9a69cab967a2d76e575338b1c2e1a5614f8fff9a2685697ce3aa122499da2" name="a8fdf9a69cab967a2d76e575338b1c2e1a5614f8fff9a2685697ce3aa122499da2"></a>CART_LOAD_ERR_EMU_LOAD_FAIL&#160;</td><td class="fielddoc"><p >Failed to load the emulator required. </p>
</td></tr>
<tr><td class="fieldname"><a id="a8fdf9a69cab967a2d76e575338b1c2e1aefad8c3079967d11ae9be1bd78d2098f" name="a8fdf9a69cab967a2d76e575338b1c2e1aefad8c3079967d11ae9be1bd78d2098f"></a>CART_LOAD_ERR_CREATE_SAVES_SUBDIR_FAIL&#160;</td><td class="fielddoc"><p >Failed to create the save sub-directory. </p>
</td></tr>
<tr><td class="fieldname"><a id="a8fdf9a69cab967a2d76e575338b1c2e1a56c5993cab82de5c3c9c495153295474" name="a8fdf9a69cab967a2d76e575338b1c2e1a56c5993cab82de5c3c9c495153295474"></a>CART_LOAD_ERR_EXP_PAK_NOT_FOUND&#160;</td><td class="fielddoc"><p >There was not enough system memory available (expected an Expansion PAK). </p>
</td></tr>
<tr><td class="fieldname"><a id="a8fdf9a69cab967a2d76e575338b1c2e1aec87a2398fb3cda8b6a4dcc2bf6debde" name="a8fdf9a69cab967a2d76e575338b1c2e1aec87a2398fb3cda8b6a4dcc2bf6debde"></a>CART_LOAD_ERR_FUNCTION_NOT_SUPPORTED&#160;</td><td class="fielddoc"><p >An unexpected response. </p>
</td></tr>
</table>
</div>
</div>
<a id="abe82a7d601e4b10ab65184b8aebde2bf" name="abe82a7d601e4b10ab65184b8aebde2bf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abe82a7d601e4b10ab65184b8aebde2bf">&#9670;&#160;</a></span>cart_load_emu_type_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="cart__load_8h.html#abe82a7d601e4b10ab65184b8aebde2bf">cart_load_emu_type_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Cart load type enumeration. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="abe82a7d601e4b10ab65184b8aebde2bfa7d3d6237c3ba74a6f976f0fc960d2fc8" name="abe82a7d601e4b10ab65184b8aebde2bfa7d3d6237c3ba74a6f976f0fc960d2fc8"></a>CART_LOAD_EMU_TYPE_NES&#160;</td><td class="fielddoc"><p >The ROM is designed for a Nintendo Entertainment System or Famicom. </p>
</td></tr>
<tr><td class="fieldname"><a id="abe82a7d601e4b10ab65184b8aebde2bfa390aa1196d1fbec39236a891871de082" name="abe82a7d601e4b10ab65184b8aebde2bfa390aa1196d1fbec39236a891871de082"></a>CART_LOAD_EMU_TYPE_SNES&#160;</td><td class="fielddoc"><p >The ROM is designed for a Super Nintendo Entertainment System or Super Famicom. </p>
</td></tr>
<tr><td class="fieldname"><a id="abe82a7d601e4b10ab65184b8aebde2bfab0ff2ec231e699a01af2d0aa130a394d" name="abe82a7d601e4b10ab65184b8aebde2bfab0ff2ec231e699a01af2d0aa130a394d"></a>CART_LOAD_EMU_TYPE_GAMEBOY&#160;</td><td class="fielddoc"><p >The ROM is designed for a Nintendo Gameboy. </p>
</td></tr>
<tr><td class="fieldname"><a id="abe82a7d601e4b10ab65184b8aebde2bfa3395e659a0a25fd963691ff6288d4cf3" name="abe82a7d601e4b10ab65184b8aebde2bfa3395e659a0a25fd963691ff6288d4cf3"></a>CART_LOAD_EMU_TYPE_GAMEBOY_COLOR&#160;</td><td class="fielddoc"><p >The ROM is designed for a Nintendo Gameboy Color. </p>
</td></tr>
<tr><td class="fieldname"><a id="abe82a7d601e4b10ab65184b8aebde2bfa357930eb0490e5517270e57dbadbae66" name="abe82a7d601e4b10ab65184b8aebde2bfa357930eb0490e5517270e57dbadbae66"></a>CART_LOAD_EMU_TYPE_SEGA_GENERIC_8BIT&#160;</td><td class="fielddoc"><p >The ROM is designed for a Sega 8Bit system (Game Gear or Master System). </p>
</td></tr>
</table>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Dec 6 2023 23:36:57 for N64FlashcartMenu by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.5
</small></address>
</body>
</html>