updated docs
[sdlgit/SDL-Site.git] / pages / SDL-CDROM.html-inc
1 <div class="pod">
2 <!-- INDEX START -->
3 <h3 id="TOP">Index</h3>
4
5 <ul><li><a href="#NAME">NAME</a></li>
6 <li><a href="#CATEGORY">CATEGORY</a></li>
7 <li><a href="#SYNOPSIS">SYNOPSIS</a></li>
8 <li><a href="#METHODS">METHODS</a>
9 <ul><li><a href="#num_drives">num_drives</a></li>
10 <li><a href="#name">name</a></li>
11 </ul>
12 </li>
13 <li><a href="#See_Also">See Also</a></li>
14 <li><a href="#AUTHORS">AUTHORS</a>
15 </li>
16 </ul><hr />
17 <!-- INDEX END -->
18
19 <h1 id="NAME">NAME</h1><p><a href="#TOP" class="toplink">Top</a></p>
20 <div id="NAME_CONTENT">
21 <p>SDL::CDROM -- SDL Bindings for the CDROM device</p>
22
23 </div>
24 <h1 id="CATEGORY">CATEGORY</h1><p><a href="#TOP" class="toplink">Top</a></p>
25 <div id="CATEGORY_CONTENT">
26 <p>Core, CDROM</p>
27
28 </div>
29 <h1 id="SYNOPSIS">SYNOPSIS</h1><p><a href="#TOP" class="toplink">Top</a></p>
30 <div id="SYNOPSIS_CONTENT">
31 <pre> use SDL ':init';
32  use SDL::CDROM;
33
34  SDL::init(SDL_INIT_CDROM);
35
36  print SDL::CDROM::num_drives();
37
38  print SDL::CDROM::name(0);
39
40  SDL::quit();
41
42 </pre>
43
44 </div>
45 <h1 id="METHODS">METHODS</h1><p><a href="#TOP" class="toplink">Top</a></p>
46 <div id="METHODS_CONTENT">
47
48 </div>
49 <h2 id="num_drives">num_drives</h2>
50 <div id="num_drives_CONTENT">
51 <pre> my $drives = SDL::CDROM::num_drives(); 
52
53 </pre>
54 <p>Returns number of drives available on the system</p>
55
56 </div>
57 <h2 id="name">name</h2>
58 <div id="name_CONTENT">
59 <pre> my $drive_name = SDL::CDROM::name($drive_num);
60
61 </pre>
62 <p>Returns human readable name for CDROM device</p>
63 <p>Examples:</p>
64 <ul>
65                 <li>'/dev/cdrom'        </li>
66                 <li>'E:'        </li>
67                 <li>'/dev/disk/ide/1/master'  </li>
68 </ul>
69
70
71 </div>
72 <h1 id="See_Also">See Also</h1><p><a href="#TOP" class="toplink">Top</a></p>
73 <div id="See_Also_CONTENT">
74 <p><a href="SDL-CD.html">SDL::CD</a>, <a href="SDL-CDTrack.html">SDL::CDTrack</a></p>
75
76 </div>
77 <h1 id="AUTHORS">AUTHORS</h1><p><a href="#TOP" class="toplink">Top</a></p>
78 <div id="AUTHORS_CONTENT">
79 <p>See <b>AUTHORS</b> in <cite>SDL</cite>.</p>
80
81 </div>
82 </div>