mirror of
https://github.com/0ldsk00l/nestopia.git
synced 2025-04-02 10:31:51 -04:00
521 lines
14 KiB
HTML
521 lines
14 KiB
HTML
<HTML>
|
|
|
|
<HEAD>
|
|
<!-- Generated by CppDoc v2.4.1 on June 07, 2008 at 22:48-->
|
|
|
|
<META NAME="GENERATOR" Content="CppDoc">
|
|
<TITLE>Nestopia Core API: Nes::Result</TITLE>
|
|
|
|
</HEAD>
|
|
|
|
<BODY>
|
|
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
|
|
<TR>
|
|
<TD COLSPAN=2 BGCOLOR="#eeeeff">
|
|
<A NAME="navbar_top_firstrow"><!-- --></A>
|
|
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
|
|
<TR ALIGN="center" VALIGN="top">
|
|
<TD BGCOLOR="#eeeeff"> <a href="../../index-overview-summary.html"><B>Overview</B></a> </TD>
|
|
<TD BGCOLOR="#eeeeff"> <a href="project-summary.html"><B>Project</B></a> </TD>
|
|
<TD BGCOLOR="navy"> <FONT COLOR="white"> <B>Class</B></FONT> </TD>
|
|
<TD BGCOLOR="#eeeeff"> <a href="project-tree.html"><B>Tree</B></a> </TD>
|
|
<TD BGCOLOR="#eeeeff"> <a href="../../index-deprecated-list.html"><B>Deprecated</B></a> </TD>
|
|
<TD BGCOLOR="#eeeeff"> <a href="../../index-all.html"><B>Index</B></a> </TD>
|
|
</TR>
|
|
</TABLE>
|
|
</TD>
|
|
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
|
<B>Nestopia Core API</B></EM>
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR>
|
|
<TD><FONT SIZE="-2">
|
|
<a href="../../index.html" target="_top"><B>FRAMES</B></a>
|
|
<a href="../core/Nes..Result.html" target="_top"><B>NO FRAMES</B></a></FONT></TD>
|
|
</TR>
|
|
<TR>
|
|
<TD VALIGN="top"><FONT SIZE="-2">
|
|
SUMMARY: INNER | <A HREF="#field_summary">FIELD</A> | CONSTR | METHOD</FONT></TD>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | METHOD</FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
<!-- =========== END OF NAVBAR =========== -->
|
|
|
|
<HR>
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<H2>
|
|
<FONT SIZE="-1">
|
|
core</FONT>
|
|
<BR>
|
|
Enum Nes::Result</H2>
|
|
<p>General result codes.
|
|
<p>
|
|
|
|
|
|
<HR>
|
|
|
|
|
|
<!-- =========== FIELD SUMMARY =========== -->
|
|
|
|
<A NAME="field_summary"><!-- --></A>
|
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
|
<TR BGCOLOR="#ccccff">
|
|
<TD COLSPAN=2><FONT SIZE="+2">
|
|
<B>Field Summary</B></FONT></TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD><CODE><B><a href="#RESULT_ERR_CORRUPT_FILE">RESULT_ERR_CORRUPT_FILE</a></B> = -6</CODE>
|
|
|
|
<BR>
|
|
Corrupt file.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD><CODE><B><a href="#RESULT_ERR_GENERIC">RESULT_ERR_GENERIC</a></B> = -1</CODE>
|
|
|
|
<BR>
|
|
Generic error.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD><CODE><B><a href="#RESULT_ERR_INVALID_CRC">RESULT_ERR_INVALID_CRC</a></B> = -7</CODE>
|
|
|
|
<BR>
|
|
Invalid CRC checksum.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD><CODE><B><a href="#RESULT_ERR_INVALID_FILE">RESULT_ERR_INVALID_FILE</a></B> = -5</CODE>
|
|
|
|
<BR>
|
|
Invalid file.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD><CODE><B><a href="#RESULT_ERR_INVALID_PARAM">RESULT_ERR_INVALID_PARAM</a></B> = -4</CODE>
|
|
|
|
<BR>
|
|
Invalid parameter(s).</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD><CODE><B><a href="#RESULT_ERR_MISSING_BIOS">RESULT_ERR_MISSING_BIOS</a></B> = -12</CODE>
|
|
|
|
<BR>
|
|
Missing FDS BIOS.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD><CODE><B><a href="#RESULT_ERR_NOT_READY">RESULT_ERR_NOT_READY</a></B> = -3</CODE>
|
|
|
|
<BR>
|
|
System not ready.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD><CODE><B><a href="#RESULT_ERR_OUT_OF_MEMORY">RESULT_ERR_OUT_OF_MEMORY</a></B> = -2</CODE>
|
|
|
|
<BR>
|
|
Out of memory.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD><CODE><B><a href="#RESULT_ERR_UNSUPPORTED">RESULT_ERR_UNSUPPORTED</a></B> = -8</CODE>
|
|
|
|
<BR>
|
|
Unsupported operation.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD><CODE><B><a href="#RESULT_ERR_UNSUPPORTED_FILE_VERSION">RESULT_ERR_UNSUPPORTED_FILE_VERSION</a></B> = -9</CODE>
|
|
|
|
<BR>
|
|
File format version is no longer supported.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD><CODE><B><a href="#RESULT_ERR_UNSUPPORTED_MAPPER">RESULT_ERR_UNSUPPORTED_MAPPER</a></B> = -11</CODE>
|
|
|
|
<BR>
|
|
Unsupported or malformed mapper.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD><CODE><B><a href="#RESULT_ERR_UNSUPPORTED_VSSYSTEM">RESULT_ERR_UNSUPPORTED_VSSYSTEM</a></B> = -10</CODE>
|
|
|
|
<BR>
|
|
Vs DualSystem is unsupported.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD><CODE><B><a href="#RESULT_ERR_WRONG_MODE">RESULT_ERR_WRONG_MODE</a></B> = -13</CODE>
|
|
|
|
<BR>
|
|
NTSC/PAL region mismatch.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD><CODE><B><a href="#RESULT_NOP">RESULT_NOP</a></B> = 1</CODE>
|
|
|
|
<BR>
|
|
Success but operation had no effect.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD><CODE><B><a href="#RESULT_OK">RESULT_OK</a></B> = 0</CODE>
|
|
|
|
<BR>
|
|
Success.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD><CODE><B><a href="#RESULT_WARN_BAD_CROM">RESULT_WARN_BAD_CROM</a></B> = 4</CODE>
|
|
|
|
<BR>
|
|
Success but CHR-ROM may be bad.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD><CODE><B><a href="#RESULT_WARN_BAD_DUMP">RESULT_WARN_BAD_DUMP</a></B> = 2</CODE>
|
|
|
|
<BR>
|
|
Success but image dump may be bad.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD><CODE><B><a href="#RESULT_WARN_BAD_FILE_HEADER">RESULT_WARN_BAD_FILE_HEADER</a></B> = 5</CODE>
|
|
|
|
<BR>
|
|
Success but file header may have incorrect data.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD><CODE><B><a href="#RESULT_WARN_BAD_PROM">RESULT_WARN_BAD_PROM</a></B> = 3</CODE>
|
|
|
|
<BR>
|
|
Success but PRG-ROM may be bad.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD><CODE><B><a href="#RESULT_WARN_DATA_REPLACED">RESULT_WARN_DATA_REPLACED</a></B> = 8</CODE>
|
|
|
|
<BR>
|
|
Success but data may have been replaced.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD><CODE><B><a href="#RESULT_WARN_SAVEDATA_LOST">RESULT_WARN_SAVEDATA_LOST</a></B> = 6</CODE>
|
|
|
|
<BR>
|
|
Success but save data has been lost.</TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
|
|
<BR>
|
|
<BR>
|
|
<!-- ============ Field Detail ========== -->
|
|
|
|
<A NAME="field_detail"><!-- --></A>
|
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
|
<TR BGCOLOR="#ccccff">
|
|
<TD COLSPAN=1><FONT SIZE="+2">
|
|
<B>Field Detail</B></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<A NAME="RESULT_ERR_CORRUPT_FILE"><!-- --></A>
|
|
<A NAME="RESULT_ERR_CORRUPT_FILE"><!-- --></A>
|
|
<H3>RESULT_ERR_CORRUPT_FILE</H3>
|
|
<PRE>
|
|
public <B>RESULT_ERR_CORRUPT_FILE</B> = -6
|
|
</PRE>
|
|
<DL>
|
|
<DD>Corrupt file.
|
|
</DD>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="RESULT_ERR_GENERIC"><!-- --></A>
|
|
<A NAME="RESULT_ERR_GENERIC"><!-- --></A>
|
|
<H3>RESULT_ERR_GENERIC</H3>
|
|
<PRE>
|
|
public <B>RESULT_ERR_GENERIC</B> = -1
|
|
</PRE>
|
|
<DL>
|
|
<DD>Generic error.
|
|
</DD>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="RESULT_ERR_INVALID_CRC"><!-- --></A>
|
|
<A NAME="RESULT_ERR_INVALID_CRC"><!-- --></A>
|
|
<H3>RESULT_ERR_INVALID_CRC</H3>
|
|
<PRE>
|
|
public <B>RESULT_ERR_INVALID_CRC</B> = -7
|
|
</PRE>
|
|
<DL>
|
|
<DD>Invalid CRC checksum.
|
|
</DD>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="RESULT_ERR_INVALID_FILE"><!-- --></A>
|
|
<A NAME="RESULT_ERR_INVALID_FILE"><!-- --></A>
|
|
<H3>RESULT_ERR_INVALID_FILE</H3>
|
|
<PRE>
|
|
public <B>RESULT_ERR_INVALID_FILE</B> = -5
|
|
</PRE>
|
|
<DL>
|
|
<DD>Invalid file.
|
|
</DD>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="RESULT_ERR_INVALID_PARAM"><!-- --></A>
|
|
<A NAME="RESULT_ERR_INVALID_PARAM"><!-- --></A>
|
|
<H3>RESULT_ERR_INVALID_PARAM</H3>
|
|
<PRE>
|
|
public <B>RESULT_ERR_INVALID_PARAM</B> = -4
|
|
</PRE>
|
|
<DL>
|
|
<DD>Invalid parameter(s).
|
|
</DD>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="RESULT_ERR_MISSING_BIOS"><!-- --></A>
|
|
<A NAME="RESULT_ERR_MISSING_BIOS"><!-- --></A>
|
|
<H3>RESULT_ERR_MISSING_BIOS</H3>
|
|
<PRE>
|
|
public <B>RESULT_ERR_MISSING_BIOS</B> = -12
|
|
</PRE>
|
|
<DL>
|
|
<DD>Missing FDS BIOS.
|
|
</DD>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="RESULT_ERR_NOT_READY"><!-- --></A>
|
|
<A NAME="RESULT_ERR_NOT_READY"><!-- --></A>
|
|
<H3>RESULT_ERR_NOT_READY</H3>
|
|
<PRE>
|
|
public <B>RESULT_ERR_NOT_READY</B> = -3
|
|
</PRE>
|
|
<DL>
|
|
<DD>System not ready.
|
|
</DD>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="RESULT_ERR_OUT_OF_MEMORY"><!-- --></A>
|
|
<A NAME="RESULT_ERR_OUT_OF_MEMORY"><!-- --></A>
|
|
<H3>RESULT_ERR_OUT_OF_MEMORY</H3>
|
|
<PRE>
|
|
public <B>RESULT_ERR_OUT_OF_MEMORY</B> = -2
|
|
</PRE>
|
|
<DL>
|
|
<DD>Out of memory.
|
|
</DD>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="RESULT_ERR_UNSUPPORTED"><!-- --></A>
|
|
<A NAME="RESULT_ERR_UNSUPPORTED"><!-- --></A>
|
|
<H3>RESULT_ERR_UNSUPPORTED</H3>
|
|
<PRE>
|
|
public <B>RESULT_ERR_UNSUPPORTED</B> = -8
|
|
</PRE>
|
|
<DL>
|
|
<DD>Unsupported operation.
|
|
</DD>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="RESULT_ERR_UNSUPPORTED_FILE_VERSION"><!-- --></A>
|
|
<A NAME="RESULT_ERR_UNSUPPORTED_FILE_VERSION"><!-- --></A>
|
|
<H3>RESULT_ERR_UNSUPPORTED_FILE_VERSION</H3>
|
|
<PRE>
|
|
public <B>RESULT_ERR_UNSUPPORTED_FILE_VERSION</B> = -9
|
|
</PRE>
|
|
<DL>
|
|
<DD>File format version is no longer supported.
|
|
</DD>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="RESULT_ERR_UNSUPPORTED_MAPPER"><!-- --></A>
|
|
<A NAME="RESULT_ERR_UNSUPPORTED_MAPPER"><!-- --></A>
|
|
<H3>RESULT_ERR_UNSUPPORTED_MAPPER</H3>
|
|
<PRE>
|
|
public <B>RESULT_ERR_UNSUPPORTED_MAPPER</B> = -11
|
|
</PRE>
|
|
<DL>
|
|
<DD>Unsupported or malformed mapper.
|
|
</DD>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="RESULT_ERR_UNSUPPORTED_VSSYSTEM"><!-- --></A>
|
|
<A NAME="RESULT_ERR_UNSUPPORTED_VSSYSTEM"><!-- --></A>
|
|
<H3>RESULT_ERR_UNSUPPORTED_VSSYSTEM</H3>
|
|
<PRE>
|
|
public <B>RESULT_ERR_UNSUPPORTED_VSSYSTEM</B> = -10
|
|
</PRE>
|
|
<DL>
|
|
<DD>Vs DualSystem is unsupported.
|
|
</DD>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="RESULT_ERR_WRONG_MODE"><!-- --></A>
|
|
<A NAME="RESULT_ERR_WRONG_MODE"><!-- --></A>
|
|
<H3>RESULT_ERR_WRONG_MODE</H3>
|
|
<PRE>
|
|
public <B>RESULT_ERR_WRONG_MODE</B> = -13
|
|
</PRE>
|
|
<DL>
|
|
<DD>NTSC/PAL region mismatch.
|
|
</DD>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="RESULT_NOP"><!-- --></A>
|
|
<A NAME="RESULT_NOP"><!-- --></A>
|
|
<H3>RESULT_NOP</H3>
|
|
<PRE>
|
|
public <B>RESULT_NOP</B> = 1
|
|
</PRE>
|
|
<DL>
|
|
<DD>Success but operation had no effect.
|
|
</DD>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="RESULT_OK"><!-- --></A>
|
|
<A NAME="RESULT_OK"><!-- --></A>
|
|
<H3>RESULT_OK</H3>
|
|
<PRE>
|
|
public <B>RESULT_OK</B> = 0
|
|
</PRE>
|
|
<DL>
|
|
<DD>Success.
|
|
</DD>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="RESULT_WARN_BAD_CROM"><!-- --></A>
|
|
<A NAME="RESULT_WARN_BAD_CROM"><!-- --></A>
|
|
<H3>RESULT_WARN_BAD_CROM</H3>
|
|
<PRE>
|
|
public <B>RESULT_WARN_BAD_CROM</B> = 4
|
|
</PRE>
|
|
<DL>
|
|
<DD>Success but CHR-ROM may be bad.
|
|
</DD>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="RESULT_WARN_BAD_DUMP"><!-- --></A>
|
|
<A NAME="RESULT_WARN_BAD_DUMP"><!-- --></A>
|
|
<H3>RESULT_WARN_BAD_DUMP</H3>
|
|
<PRE>
|
|
public <B>RESULT_WARN_BAD_DUMP</B> = 2
|
|
</PRE>
|
|
<DL>
|
|
<DD>Success but image dump may be bad.
|
|
</DD>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="RESULT_WARN_BAD_FILE_HEADER"><!-- --></A>
|
|
<A NAME="RESULT_WARN_BAD_FILE_HEADER"><!-- --></A>
|
|
<H3>RESULT_WARN_BAD_FILE_HEADER</H3>
|
|
<PRE>
|
|
public <B>RESULT_WARN_BAD_FILE_HEADER</B> = 5
|
|
</PRE>
|
|
<DL>
|
|
<DD>Success but file header may have incorrect data.
|
|
</DD>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="RESULT_WARN_BAD_PROM"><!-- --></A>
|
|
<A NAME="RESULT_WARN_BAD_PROM"><!-- --></A>
|
|
<H3>RESULT_WARN_BAD_PROM</H3>
|
|
<PRE>
|
|
public <B>RESULT_WARN_BAD_PROM</B> = 3
|
|
</PRE>
|
|
<DL>
|
|
<DD>Success but PRG-ROM may be bad.
|
|
</DD>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="RESULT_WARN_DATA_REPLACED"><!-- --></A>
|
|
<A NAME="RESULT_WARN_DATA_REPLACED"><!-- --></A>
|
|
<H3>RESULT_WARN_DATA_REPLACED</H3>
|
|
<PRE>
|
|
public <B>RESULT_WARN_DATA_REPLACED</B> = 8
|
|
</PRE>
|
|
<DL>
|
|
<DD>Success but data may have been replaced.
|
|
</DD>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="RESULT_WARN_SAVEDATA_LOST"><!-- --></A>
|
|
<A NAME="RESULT_WARN_SAVEDATA_LOST"><!-- --></A>
|
|
<H3>RESULT_WARN_SAVEDATA_LOST</H3>
|
|
<PRE>
|
|
public <B>RESULT_WARN_SAVEDATA_LOST</B> = 6
|
|
</PRE>
|
|
<DL>
|
|
<DD>Success but save data has been lost.
|
|
</DD>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
|
|
<TR>
|
|
<TD COLSPAN=2 BGCOLOR="#eeeeff">
|
|
<A NAME="navbar_top_firstrow"><!-- --></A>
|
|
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
|
|
<TR ALIGN="center" VALIGN="top">
|
|
<TD BGCOLOR="#eeeeff"> <a href="../../index-overview-summary.html"><B>Overview</B></a> </TD>
|
|
<TD BGCOLOR="#eeeeff"> <a href="project-summary.html"><B>Project</B></a> </TD>
|
|
<TD BGCOLOR="navy"> <FONT COLOR="white"> <B>Class</B></FONT> </TD>
|
|
<TD BGCOLOR="#eeeeff"> <a href="project-tree.html"><B>Tree</B></a> </TD>
|
|
<TD BGCOLOR="#eeeeff"> <a href="../../index-deprecated-list.html"><B>Deprecated</B></a> </TD>
|
|
<TD BGCOLOR="#eeeeff"> <a href="../../index-all.html"><B>Index</B></a> </TD>
|
|
</TR>
|
|
</TABLE>
|
|
</TD>
|
|
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
|
<B>Nestopia Core API</B></EM>
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR>
|
|
<TD><FONT SIZE="-2">
|
|
<a href="../../index.html" target="_top"><B>FRAMES</B></a>
|
|
<a href="../core/Nes..Result.html" target="_top"><B>NO FRAMES</B></a></FONT></TD>
|
|
</TR>
|
|
<TR>
|
|
<TD VALIGN="top"><FONT SIZE="-2">
|
|
SUMMARY: INNER | <A HREF="#field_summary">FIELD</A> | CONSTR | METHOD</FONT></TD>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | METHOD</FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
<!-- =========== END OF NAVBAR =========== -->
|
|
|
|
<HR>
|
|
|
|
|
|
</BODY>
|
|
|
|
</HTML>
|
|
|