Mercurial > sdl-ios-xcode
annotate docs/html/sdlcdname.html @ 3164:c5b2884c26b4
Added an ifdef so that if you
#define SDL_NO_COMPAT
before you include SDL.h then SDL_compat.h will never be included in your code.
This is useful for making sure that your code uses only SDL 1.3 features.
It is also handy for finding things that are in SDL_compat.h that belong elsewhere.
author | Bob Pendleton <bob@pendleton.com> |
---|---|
date | Thu, 04 Jun 2009 21:00:45 +0000 |
parents | 355632dca928 |
children |
rev | line source |
---|---|
0 | 1 <HTML |
2 ><HEAD | |
3 ><TITLE | |
4 >SDL_CDName</TITLE | |
5 ><META | |
6 NAME="GENERATOR" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
7 CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ |
0 | 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_CDNumDrives" | |
17 HREF="sdlcdnumdrives.html"><LINK | |
18 REL="NEXT" | |
19 TITLE="SDL_CDOpen" | |
20 HREF="sdlcdopen.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 | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
31 SUMMARY="Header navigation table" |
0 | 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="sdlcdnumdrives.html" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
49 ACCESSKEY="P" |
0 | 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="sdlcdopen.html" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
63 ACCESSKEY="N" |
0 | 64 >Next</A |
65 ></TD | |
66 ></TR | |
67 ></TABLE | |
68 ><HR | |
69 ALIGN="LEFT" | |
70 WIDTH="100%"></DIV | |
71 ><H1 | |
72 ><A | |
73 NAME="SDLCDNAME" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
74 ></A |
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
75 >SDL_CDName</H1 |
0 | 76 ><DIV |
77 CLASS="REFNAMEDIV" | |
78 ><A | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
79 NAME="AEN7240" |
0 | 80 ></A |
81 ><H2 | |
82 >Name</H2 | |
83 >SDL_CDName -- Returns a human-readable, system-dependent identifier for the CD-ROM.</DIV | |
84 ><DIV | |
85 CLASS="REFSYNOPSISDIV" | |
86 ><A | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
87 NAME="AEN7243" |
0 | 88 ></A |
89 ><H2 | |
90 >Synopsis</H2 | |
91 ><DIV | |
92 CLASS="FUNCSYNOPSIS" | |
93 ><A | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
94 NAME="AEN7244" |
0 | 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 >const char *<B | |
106 CLASS="FSFUNC" | |
107 >SDL_CDName</B | |
108 ></CODE | |
109 >(int drive);</CODE | |
110 ></P | |
111 ><P | |
112 ></P | |
113 ></DIV | |
114 ></DIV | |
115 ><DIV | |
116 CLASS="REFSECT1" | |
117 ><A | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
118 NAME="AEN7250" |
0 | 119 ></A |
120 ><H2 | |
121 >Description</H2 | |
122 ><P | |
123 >Returns a human-readable, system-dependent identifier for the CD-ROM. <TT | |
124 CLASS="PARAMETER" | |
125 ><I | |
126 >drive</I | |
127 ></TT | |
128 > is the index of the drive. Drive indices start to 0 and end at <TT | |
129 CLASS="FUNCTION" | |
130 >SDL_CDNumDrives()</TT | |
131 >-1.</P | |
132 ></DIV | |
133 ><DIV | |
134 CLASS="REFSECT1" | |
135 ><A | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
136 NAME="AEN7255" |
0 | 137 ></A |
138 ><H2 | |
139 >Examples</H2 | |
140 ><P | |
141 ><P | |
142 ></P | |
143 ><UL | |
144 ><LI | |
145 ><P | |
146 >"/dev/cdrom"</P | |
147 ></LI | |
148 ><LI | |
149 ><P | |
150 >"E:"</P | |
151 ></LI | |
152 ><LI | |
153 ><P | |
154 >"/dev/disk/ide/1/master"</P | |
155 ></LI | |
156 ></UL | |
157 ></P | |
158 ></DIV | |
159 ><DIV | |
160 CLASS="REFSECT1" | |
161 ><A | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
162 NAME="AEN7265" |
0 | 163 ></A |
164 ><H2 | |
165 >See Also</H2 | |
166 ><P | |
167 ><A | |
168 HREF="sdlcdnumdrives.html" | |
169 ><TT | |
170 CLASS="FUNCTION" | |
171 >SDL_CDNumDrives</TT | |
172 ></A | |
173 ></P | |
174 ></DIV | |
175 ><DIV | |
176 CLASS="NAVFOOTER" | |
177 ><HR | |
178 ALIGN="LEFT" | |
179 WIDTH="100%"><TABLE | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
180 SUMMARY="Footer navigation table" |
0 | 181 WIDTH="100%" |
182 BORDER="0" | |
183 CELLPADDING="0" | |
184 CELLSPACING="0" | |
185 ><TR | |
186 ><TD | |
187 WIDTH="33%" | |
188 ALIGN="left" | |
189 VALIGN="top" | |
190 ><A | |
191 HREF="sdlcdnumdrives.html" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
192 ACCESSKEY="P" |
0 | 193 >Prev</A |
194 ></TD | |
195 ><TD | |
196 WIDTH="34%" | |
197 ALIGN="center" | |
198 VALIGN="top" | |
199 ><A | |
200 HREF="index.html" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
201 ACCESSKEY="H" |
0 | 202 >Home</A |
203 ></TD | |
204 ><TD | |
205 WIDTH="33%" | |
206 ALIGN="right" | |
207 VALIGN="top" | |
208 ><A | |
209 HREF="sdlcdopen.html" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
210 ACCESSKEY="N" |
0 | 211 >Next</A |
212 ></TD | |
213 ></TR | |
214 ><TR | |
215 ><TD | |
216 WIDTH="33%" | |
217 ALIGN="left" | |
218 VALIGN="top" | |
219 >SDL_CDNumDrives</TD | |
220 ><TD | |
221 WIDTH="34%" | |
222 ALIGN="center" | |
223 VALIGN="top" | |
224 ><A | |
225 HREF="cdrom.html" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
226 ACCESSKEY="U" |
0 | 227 >Up</A |
228 ></TD | |
229 ><TD | |
230 WIDTH="33%" | |
231 ALIGN="right" | |
232 VALIGN="top" | |
233 >SDL_CDOpen</TD | |
234 ></TR | |
235 ></TABLE | |
236 ></DIV | |
237 ></BODY | |
238 ></HTML | |
239 > |