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

<HTML
><HEAD
><TITLE
>SDL_JoystickName</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="Joystick"
HREF="joystick.html"><LINK
REL="PREVIOUS"
TITLE="SDL_NumJoysticks"
HREF="sdlnumjoysticks.html"><LINK
REL="NEXT"
TITLE="SDL_JoystickOpen"
HREF="sdljoystickopen.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="sdlnumjoysticks.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="sdljoystickopen.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="SDLJOYSTICKNAME"
></A
>SDL_JoystickName</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN6066"
></A
><H2
>Name</H2
>SDL_JoystickName&nbsp;--&nbsp;Get joystick name.</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN6069"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><A
NAME="AEN6070"
></A
><P
></P
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include "SDL.h"</PRE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>const char *<B
CLASS="FSFUNC"
>SDL_JoystickName</B
></CODE
>(int index);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN6076"
></A
><H2
>Description</H2
><P
>Get the implementation dependent name of joystick. The <TT
CLASS="PARAMETER"
><I
>index</I
></TT
> parameter refers to the N'th joystick on the system.</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN6080"
></A
><H2
>Return Value</H2
><P
>Returns a char pointer to the joystick name.</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN6083"
></A
><H2
>Examples</H2
><P
><PRE
CLASS="PROGRAMLISTING"
>/* Print the names of all attached joysticks */
int num_joy, i;
num_joy=SDL_NumJoysticks();
printf("%d joysticks found\n", num_joy);
for(i=0;i&#60;num_joy;i++)
  printf("%s\n", SDL_JoystickName(i));</PRE
></P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN6087"
></A
><H2
>See Also</H2
><P
><A
HREF="sdljoystickopen.html"
><TT
CLASS="FUNCTION"
>SDL_JoystickOpen</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="sdlnumjoysticks.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="sdljoystickopen.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>SDL_NumJoysticks</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="joystick.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>SDL_JoystickOpen</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>
Commit	Line	Data
e14743d1	1	<HTML
	2	><HEAD
	3	><TITLE
	4	>SDL_JoystickName</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="Joystick"
	14	HREF="joystick.html"><LINK
	15	REL="PREVIOUS"
	16	TITLE="SDL_NumJoysticks"
	17	HREF="sdlnumjoysticks.html"><LINK
	18	REL="NEXT"
	19	TITLE="SDL_JoystickOpen"
	20	HREF="sdljoystickopen.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="sdlnumjoysticks.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="sdljoystickopen.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="SDLJOYSTICKNAME"
74	></A
75	>SDL_JoystickName</H1
76	><DIV
77	CLASS="REFNAMEDIV"
78	><A
79	NAME="AEN6066"
80	></A
81	><H2
82	>Name</H2
83	>SDL_JoystickName -- Get joystick name.</DIV
84	><DIV
85	CLASS="REFSYNOPSISDIV"
86	><A
87	NAME="AEN6069"
88	></A
89	><H2
90	>Synopsis</H2
91	><DIV
92	CLASS="FUNCSYNOPSIS"
93	><A
94	NAME="AEN6070"
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_JoystickName</B
108	></CODE
109	>(int index);</CODE
110	></P
111	><P
112	></P
113	></DIV
114	></DIV
115	><DIV
116	CLASS="REFSECT1"
117	><A
118	NAME="AEN6076"
119	></A
120	><H2
121	>Description</H2
122	><P
123	>Get the implementation dependent name of joystick. The <TT
124	CLASS="PARAMETER"
125	><I
126	>index</I
127	></TT
128	> parameter refers to the N'th joystick on the system.</P
129	></DIV
130	><DIV
131	CLASS="REFSECT1"
132	><A
133	NAME="AEN6080"
134	></A
135	><H2
136	>Return Value</H2
137	><P
138	>Returns a char pointer to the joystick name.</P
139	></DIV
140	><DIV
141	CLASS="REFSECT1"
142	><A
143	NAME="AEN6083"
144	></A
145	><H2
146	>Examples</H2
147	><P
148	><PRE
149	CLASS="PROGRAMLISTING"
150	>/* Print the names of all attached joysticks */
151	int num_joy, i;
152	num_joy=SDL_NumJoysticks();
153	printf("%d joysticks found\n", num_joy);
154	for(i=0;i<num_joy;i++)
155	printf("%s\n", SDL_JoystickName(i));</PRE
156	></P
157	></DIV
158	><DIV
159	CLASS="REFSECT1"
160	><A
161	NAME="AEN6087"
162	></A
163	><H2
164	>See Also</H2
165	><P
166	><A
167	HREF="sdljoystickopen.html"
168	><TT
169	CLASS="FUNCTION"
170	>SDL_JoystickOpen</TT
171	></A
172	></P
173	></DIV
174	><DIV
175	CLASS="NAVFOOTER"
176	><HR
177	ALIGN="LEFT"
178	WIDTH="100%"><TABLE
179	SUMMARY="Footer navigation table"
180	WIDTH="100%"
181	BORDER="0"
182	CELLPADDING="0"
183	CELLSPACING="0"
184	><TR
185	><TD
186	WIDTH="33%"
187	ALIGN="left"
188	VALIGN="top"
189	><A
190	HREF="sdlnumjoysticks.html"
191	ACCESSKEY="P"
192	>Prev</A
193	></TD
194	><TD
195	WIDTH="34%"
196	ALIGN="center"
197	VALIGN="top"
198	><A
199	HREF="index.html"
200	ACCESSKEY="H"
201	>Home</A
202	></TD
203	><TD
204	WIDTH="33%"
205	ALIGN="right"
206	VALIGN="top"
207	><A
208	HREF="sdljoystickopen.html"
209	ACCESSKEY="N"
210	>Next</A
211	></TD
212	></TR
213	><TR
214	><TD
215	WIDTH="33%"
216	ALIGN="left"
217	VALIGN="top"
218	>SDL_NumJoysticks</TD
219	><TD
220	WIDTH="34%"
221	ALIGN="center"
222	VALIGN="top"
223	><A
224	HREF="joystick.html"
225	ACCESSKEY="U"
226	>Up</A
227	></TD
228	><TD
229	WIDTH="33%"
230	ALIGN="right"
231	VALIGN="top"
232	>SDL_JoystickOpen</TD
233	></TR
234	></TABLE
235	></DIV
236	></BODY
237	></HTML
238	>