[sdl_omap.git] / docs / html / sdlcdopen.html

<HTML
><HEAD
><TITLE
>SDL_CDOpen</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
"><LINK
REL="HOME"
TITLE="SDL Library Documentation"
HREF="index.html"><LINK
REL="UP"
TITLE="CD-ROM"
HREF="cdrom.html"><LINK
REL="PREVIOUS"
TITLE="SDL_CDName"
HREF="sdlcdname.html"><LINK
REL="NEXT"
TITLE="SDL_CDStatus"
HREF="sdlcdstatus.html"></HEAD
><BODY
CLASS="REFENTRY"
BGCOLOR="#FFF8DC"
TEXT="#000000"
LINK="#0000ee"
VLINK="#551a8b"
ALINK="#ff0000"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>SDL Library Documentation</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="sdlcdname.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="sdlcdstatus.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="SDLCDOPEN"
></A
>SDL_CDOpen</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN7274"
></A
><H2
>Name</H2
>SDL_CDOpen&nbsp;--&nbsp;Opens a CD-ROM drive for access.</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN7277"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><A
NAME="AEN7278"
></A
><P
></P
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include "SDL.h"</PRE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>SDL_CD *<B
CLASS="FSFUNC"
>SDL_CDOpen</B
></CODE
>(int drive);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN7284"
></A
><H2
>Description</H2
><P
>Opens a CD-ROM drive for access.  It returns a <A
HREF="sdlcd.html"
><SPAN
CLASS="STRUCTNAME"
>SDL_CD</SPAN
></A
> structure on success, or <TT
CLASS="LITERAL"
>NULL</TT
> if the drive was invalid or busy.  This newly opened CD-ROM becomes the default CD used when other CD functions are passed a <TT
CLASS="LITERAL"
>NULL</TT
> CD-ROM handle. </P
><P
>Drives are numbered starting with 0.  
Drive 0 is the system default CD-ROM.</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN7292"
></A
><H2
>Examples</H2
><PRE
CLASS="PROGRAMLISTING"
>SDL_CD *cdrom;
int cur_track;
int min, sec, frame;
SDL_Init(SDL_INIT_CDROM);
atexit(SDL_Quit);

/* Check for CD drives */
if(!SDL_CDNumDrives()){
  /* None found */
  fprintf(stderr, "No CDROM devices available\n");
  exit(-1);
}

/* Open the default drive */
cdrom=SDL_CDOpen(0);

/* Did if open? Check if cdrom is NULL */
if(!cdrom){
  fprintf(stderr, "Couldn't open drive: %s\n", SDL_GetError());
  exit(-1);
}

/* Print Volume info */
printf("Name: %s\n", SDL_CDName(0));
printf("Tracks: %d\n", cdrom-&#62;numtracks);
for(cur_track=0;cur_track &#60; cdrom-&#62;numtracks; cur_track++){
  FRAMES_TO_MSF(cdrom-&#62;track[cur_track].length, &#38;min, &#38;sec, &#38;frame);
  printf("\tTrack %d: Length %d:%d\n", cur_track, min, sec);
}

SDL_CDClose(cdrom);</PRE
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN7295"
></A
><H2
>See Also</H2
><P
><A
HREF="sdlcd.html"
><SPAN
CLASS="STRUCTNAME"
>SDL_CD</SPAN
></A
>,
<A
HREF="sdlcdtrack.html"
><SPAN
CLASS="STRUCTNAME"
>SDL_CDtrack</SPAN
></A
>,
<A
HREF="sdlcdclose.html"
><TT
CLASS="FUNCTION"
>SDL_CDClose</TT
></A
></P
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="sdlcdname.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
ACCESSKEY="H"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="sdlcdstatus.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>SDL_CDName</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="cdrom.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>SDL_CDStatus</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>
Commit	Line	Data
e14743d1	1	<HTML
	2	><HEAD
	3	><TITLE
	4	>SDL_CDOpen</TITLE
	5	><META
	6	NAME="GENERATOR"
	7	CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
	8	"><LINK
	9	REL="HOME"
	10	TITLE="SDL Library Documentation"
	11	HREF="index.html"><LINK
	12	REL="UP"
	13	TITLE="CD-ROM"
	14	HREF="cdrom.html"><LINK
	15	REL="PREVIOUS"
	16	TITLE="SDL_CDName"
	17	HREF="sdlcdname.html"><LINK
	18	REL="NEXT"
	19	TITLE="SDL_CDStatus"
	20	HREF="sdlcdstatus.html"></HEAD
	21	><BODY
	22	CLASS="REFENTRY"
	23	BGCOLOR="#FFF8DC"
	24	TEXT="#000000"
	25	LINK="#0000ee"
	26	VLINK="#551a8b"
	27	ALINK="#ff0000"
	28	><DIV
	29	CLASS="NAVHEADER"
	30	><TABLE
	31	SUMMARY="Header navigation table"
	32	WIDTH="100%"
	33	BORDER="0"
	34	CELLPADDING="0"
	35	CELLSPACING="0"
	36	><TR
	37	><TH
	38	COLSPAN="3"
	39	ALIGN="center"
	40	>SDL Library Documentation</TH
	41	></TR
	42	><TR
	43	><TD
	44	WIDTH="10%"
	45	ALIGN="left"
	46	VALIGN="bottom"
	47	><A
	48	HREF="sdlcdname.html"
	49	ACCESSKEY="P"
	50	>Prev</A
	51	></TD
	52	><TD
	53	WIDTH="80%"
	54	ALIGN="center"
	55	VALIGN="bottom"
	56	></TD
	57	><TD
	58	WIDTH="10%"
	59	ALIGN="right"
	60	VALIGN="bottom"
	61	><A
	62	HREF="sdlcdstatus.html"
	63	ACCESSKEY="N"
	64	>Next</A
65	></TD
66	></TR
67	></TABLE
68	><HR
69	ALIGN="LEFT"
70	WIDTH="100%"></DIV
71	><H1
72	><A
73	NAME="SDLCDOPEN"
74	></A
75	>SDL_CDOpen</H1
76	><DIV
77	CLASS="REFNAMEDIV"
78	><A
79	NAME="AEN7274"
80	></A
81	><H2
82	>Name</H2
83	>SDL_CDOpen -- Opens a CD-ROM drive for access.</DIV
84	><DIV
85	CLASS="REFSYNOPSISDIV"
86	><A
87	NAME="AEN7277"
88	></A
89	><H2
90	>Synopsis</H2
91	><DIV
92	CLASS="FUNCSYNOPSIS"
93	><A
94	NAME="AEN7278"
95	></A
96	><P
97	></P
98	><PRE
99	CLASS="FUNCSYNOPSISINFO"
100	>#include "SDL.h"</PRE
101	><P
102	><CODE
103	><CODE
104	CLASS="FUNCDEF"
105	>SDL_CD *<B
106	CLASS="FSFUNC"
107	>SDL_CDOpen</B
108	></CODE
109	>(int drive);</CODE
110	></P
111	><P
112	></P
113	></DIV
114	></DIV
115	><DIV
116	CLASS="REFSECT1"
117	><A
118	NAME="AEN7284"
119	></A
120	><H2
121	>Description</H2
122	><P
123	>Opens a CD-ROM drive for access. It returns a <A
124	HREF="sdlcd.html"
125	><SPAN
126	CLASS="STRUCTNAME"
127	>SDL_CD</SPAN
128	></A
129	> structure on success, or <TT
130	CLASS="LITERAL"
131	>NULL</TT
132	> if the drive was invalid or busy. This newly opened CD-ROM becomes the default CD used when other CD functions are passed a <TT
133	CLASS="LITERAL"
134	>NULL</TT
135	> CD-ROM handle. </P
136	><P
137	>Drives are numbered starting with 0.
138	Drive 0 is the system default CD-ROM.</P
139	></DIV
140	><DIV
141	CLASS="REFSECT1"
142	><A
143	NAME="AEN7292"
144	></A
145	><H2
146	>Examples</H2
147	><PRE
148	CLASS="PROGRAMLISTING"
149	>SDL_CD *cdrom;
150	int cur_track;
151	int min, sec, frame;
152	SDL_Init(SDL_INIT_CDROM);
153	atexit(SDL_Quit);
154
155	/* Check for CD drives */
156	if(!SDL_CDNumDrives()){
157	/* None found */
158	fprintf(stderr, "No CDROM devices available\n");
159	exit(-1);
160	}
161
162	/* Open the default drive */
163	cdrom=SDL_CDOpen(0);
164
165	/* Did if open? Check if cdrom is NULL */
166	if(!cdrom){
167	fprintf(stderr, "Couldn't open drive: %s\n", SDL_GetError());
168	exit(-1);
169	}
170
171	/* Print Volume info */
172	printf("Name: %s\n", SDL_CDName(0));
173	printf("Tracks: %d\n", cdrom->numtracks);
174	for(cur_track=0;cur_track < cdrom->numtracks; cur_track++){
175	FRAMES_TO_MSF(cdrom->track[cur_track].length, &min, &sec, &frame);
176	printf("\tTrack %d: Length %d:%d\n", cur_track, min, sec);
177	}
178
179	SDL_CDClose(cdrom);</PRE
180	></DIV
181	><DIV
182	CLASS="REFSECT1"
183	><A
184	NAME="AEN7295"
185	></A
186	><H2
187	>See Also</H2
188	><P
189	><A
190	HREF="sdlcd.html"
191	><SPAN
192	CLASS="STRUCTNAME"
193	>SDL_CD</SPAN
194	></A
195	>,
196	<A
197	HREF="sdlcdtrack.html"
198	><SPAN
199	CLASS="STRUCTNAME"
200	>SDL_CDtrack</SPAN
201	></A
202	>,
203	<A
204	HREF="sdlcdclose.html"
205	><TT
206	CLASS="FUNCTION"
207	>SDL_CDClose</TT
208	></A
209	></P
210	></DIV
211	><DIV
212	CLASS="NAVFOOTER"
213	><HR
214	ALIGN="LEFT"
215	WIDTH="100%"><TABLE
216	SUMMARY="Footer navigation table"
217	WIDTH="100%"
218	BORDER="0"
219	CELLPADDING="0"
220	CELLSPACING="0"
221	><TR
222	><TD
223	WIDTH="33%"
224	ALIGN="left"
225	VALIGN="top"
226	><A
227	HREF="sdlcdname.html"
228	ACCESSKEY="P"
229	>Prev</A
230	></TD
231	><TD
232	WIDTH="34%"
233	ALIGN="center"
234	VALIGN="top"
235	><A
236	HREF="index.html"
237	ACCESSKEY="H"
238	>Home</A
239	></TD
240	><TD
241	WIDTH="33%"
242	ALIGN="right"
243	VALIGN="top"
244	><A
245	HREF="sdlcdstatus.html"
246	ACCESSKEY="N"
247	>Next</A
248	></TD
249	></TR
250	><TR
251	><TD
252	WIDTH="33%"
253	ALIGN="left"
254	VALIGN="top"
255	>SDL_CDName</TD
256	><TD
257	WIDTH="34%"
258	ALIGN="center"
259	VALIGN="top"
260	><A
261	HREF="cdrom.html"
262	ACCESSKEY="U"
263	>Up</A
264	></TD
265	><TD
266	WIDTH="33%"
267	ALIGN="right"
268	VALIGN="top"
269	>SDL_CDStatus</TD
270	></TR
271	></TABLE
272	></DIV
273	></BODY
274	></HTML
275	>