[sdl_omap.git] / docs / man3 / SDL_CDOpen.3

.TH "SDL_CDOpen" "3" "Tue 11 Sep 2001, 22:58" "SDL" "SDL API Reference" 
.SH "NAME"
SDL_CDOpen \- Opens a CD-ROM drive for access\&.
.SH "SYNOPSIS"
.PP
\fB#include "SDL\&.h"
.sp
\fBSDL_CD *\fBSDL_CDOpen\fP\fR(\fBint drive\fR);
.SH "DESCRIPTION"
.PP
Opens a CD-ROM drive for access\&. It returns a \fI\fBSDL_CD\fR\fR structure on success, or \fBNULL\fP if the drive was invalid or busy\&. This newly opened CD-ROM becomes the default CD used when other CD functions are passed a \fBNULL\fP CD-ROM handle\&. 
.PP
Drives are numbered starting with 0\&. Drive 0 is the system default CD-ROM\&.
.SH "EXAMPLES"
.PP
.nf
\f(CWSDL_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
");
  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
", SDL_GetError());
  exit(-1);
}

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

SDL_CDClose(cdrom);\fR
.fi
.PP
.SH "SEE ALSO"
.PP
\fI\fBSDL_CD\fR\fR, \fI\fBSDL_CDtrack\fR\fR, \fI\fBSDL_CDClose\fP\fR
.\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:58
Commit	Line	Data
e14743d1	1	.TH "SDL_CDOpen" "3" "Tue 11 Sep 2001, 22:58" "SDL" "SDL API Reference"
	2	.SH "NAME"
	3	SDL_CDOpen \- Opens a CD-ROM drive for access\&.
	4	.SH "SYNOPSIS"
	5	.PP
	6	\fB#include "SDL\&.h"
	7	.sp
	8	\fBSDL_CD *\fBSDL_CDOpen\fP\fR(\fBint drive\fR);
	9	.SH "DESCRIPTION"
	10	.PP
	11	Opens a CD-ROM drive for access\&. It returns a \fI\fBSDL_CD\fR\fR structure on success, or \fBNULL\fP if the drive was invalid or busy\&. This newly opened CD-ROM becomes the default CD used when other CD functions are passed a \fBNULL\fP CD-ROM handle\&.
	12	.PP
	13	Drives are numbered starting with 0\&. Drive 0 is the system default CD-ROM\&.
	14	.SH "EXAMPLES"
	15	.PP
	16	.nf
	17	\f(CWSDL_CD *cdrom;
	18	int cur_track;
	19	int min, sec, frame;
	20	SDL_Init(SDL_INIT_CDROM);
	21	atexit(SDL_Quit);
	22
	23	/* Check for CD drives */
	24	if(!SDL_CDNumDrives()){
	25	/* None found */
	26	fprintf(stderr, "No CDROM devices available
	27	");
	28	exit(-1);
	29	}
	30
	31	/* Open the default drive */
	32	cdrom=SDL_CDOpen(0);
	33
	34	/* Did if open? Check if cdrom is NULL */
	35	if(!cdrom){
	36	fprintf(stderr, "Couldn\&'t open drive: %s
	37	", SDL_GetError());
	38	exit(-1);
	39	}
	40
	41	/* Print Volume info */
	42	printf("Name: %s
	43	", SDL_CDName(0));
	44	printf("Tracks: %d
	45	", cdrom->numtracks);
	46	for(cur_track=0;cur_track < cdrom->numtracks; cur_track++){
	47	FRAMES_TO_MSF(cdrom->track[cur_track]\&.length, &min, &sec, &frame);
	48	printf(" Track %d: Length %d:%d
	49	", cur_track, min, sec);
	50	}
	51
	52	SDL_CDClose(cdrom);\fR
	53	.fi
	54	.PP
	55	.SH "SEE ALSO"
	56	.PP
	57	\fI\fBSDL_CD\fR\fR, \fI\fBSDL_CDtrack\fR\fR, \fI\fBSDL_CDClose\fP\fR
	58	.\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:58