1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<HTML>
3<HEAD>
4<META http-equiv="Content-Type" content="text/html; charset=windows-1252">
5<META name="GENERATOR" content="IBM WebSphere Studio Homepage Builder Version 6.5.0.0 for Windows">
6<META http-equiv="Content-Style-Type" content="text/css">
7<LINK rel="stylesheet" type="text/css" href="../CSS/revolution.css">
8<TITLE>DVDGetDriveStatus</TITLE>
9</HEAD>
10<BODY>
11<H1>DVDGetDriveStatus</H1>
12
13<H2>Syntax</H2>
14<dl><dd><pre class="construction">
15#include &lt;revolution/dvd.h&gt;
16
17s32 DVDGetDriveStatus(void);
18</pre></dd></dl>
19
20<H2>Arguments</H2>
21<P>None.</P>
22
23<H2>Return Values</H2>
24<TABLE class="arguments" border="1" >
25  <TBODY>
26    <TR>
27<TH>DVD_STATE_FATAL_ERROR</TH>
28<TD>Fatal error occurred.</TD>
29    </TR>
30    <TR>
31<TH>DVD_STATE_END</TH>
32<TD>Request complete or no request.</TD>
33    </TR>
34    <TR>
35<TH>DVD_STATE_BUSY</TH>
36<TD>Request is currently processing.</TD>
37    </TR>
38    <TR>
39<TH>DVD_STATE_NO_DISK</TH>
40<TD>No disk in the drive.</TD>
41    </TR>
42    <TR>
43<TH>DVD_STATE_WRONG_DISK</TH>
44<TD>Wrong disk in the drive.</TD>
45    </TR>
46    <TR>
47<TH>DVD_STATE_MOTOR_STOPPED</TH>
48<TD>Motor stopped.</TD>
49    </TR>
50    <TR>
51<TH>DVD_STATE_PAUSING</TH>
52<TD>The device driver is paused using the <A href="DVDPause.html"><CODE>DVD Pause</CODE></A> function.</TD>
53    </TR>
54    <TR>
55<TH>DVD_STATE_RETRY</TH>
56<TD>Retry error occurred.</TD>
57    </TR>
58  </TBODY>
59</TABLE>
60<P><strong>Note:</strong> Controller input wait state will not be supported in the near term.</P>
61<P><B>Note:</B> The error message <CODE>DVD_STATE_COVER_OPEN</CODE> used in GameCube was deleted.</P>
62<P><B><I>Note:&nbsp;</I></B> When using the release version of the DVD library, if the <CODE>DVDFileInfo</CODE> structure is used mistakenly in a program, <code>DVD_STATE_WAITING</code> may be returned. This situation can occur if the <CODE>DVDFileInfo</CODE> structure is reused in a new DVD command similar to the current DVD transfer. In the debug version of the library, this case causes an assert error.</P>
63
64<H2>Description</H2>
65<P>Gets the current status of the optical disc drive. In the case that a DVD request is currently executing, this function is the same as specifying the command block of this request using the <A href="DVDGetCommandBlockStatus.html"><CODE>DVDGetCommandBlockStatus</CODE></A> function. Depending on the pause state of the device driver and if no outstanding requests exist, the <code>DVDGetDriveStatus</code> function returns <code>DVD_STATE_END</code> or <code>DVD_STATE_PAUSING</code>. For more information about the pause state, see the <a href="DVDPause.html"><code>DVDPause</code></a> function.</P>
66<P>If this function is called in a callback, it returns <code>DVD_STATE_END</code> even if requests exist in the queue. This return code is returned because the previous request has completed processing, but the next request in the queue has not yet started processing.</P>
67<P>If no DVD command is processing, this function returns <code>DVD_STATE_END</code> or <code>DVD_STATE_PAUSING</code>. This has the following meaning.</P>
68<UL>
69<LI>If there is no currently executing DVD command, <CODE>DVDGetDriveStatus</CODE> will not return an error, even if the player removes the disc.
70</UL>
71<P>These statuses (no disc, wrong disc, and so on) are returned only if a DVD command is processing, but cannot complete because of these statuses.</P>
72
73<H2>See Also</H2>
74<P class="reference">
75<A href="DVDGetCommandBlockStatus.html">DVDGetCommandBlockStatus</A>
76</P>
77
78<H2>Revision History</H2>
79<P>
802006/09/19 Removed description of <CODE>DVD_STATE_NO_INPUT</CODE>.<BR>2006/09/07 Added description of <CODE>DVD_STATE_NO_INPUT</CODE>.<BR>2006/03/01 Initial version.<BR>
81</P>
82
83<hr><p>CONFIDENTIAL</p></body>
84</HTML>