1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html>
3
4<head>
5<META http-equiv="Content-Type" content="text/html; charset=windows-1252">
6<META name="GENERATOR" content="IBM WebSphere Studio Homepage Builder Version 7.0.0.0 for Windows">
7<META http-equiv="Content-Style-Type" content="text/css">
8<title>OS_GetFavoriteColorTable</title>
9<LINK rel="stylesheet" href="../../css/nitro.css" type="text/css">
10</head>
11
12<body>
13
14<h1 align="left">OS_GetFavoriteColor <IMG src="../../image/NTR.gif" align="middle"><IMG src="../../image/TWL.gif" align="middle"></h1>
15<h2>Syntax</h2>
16
17<dl>
18  <dd>
19<CODE>#include &lt;nitro/os.h&gt;</CODE><BR> <BR> <CODE>static inline GXRgb	OS_GetFavoriteColor(int index);</CODE><br>
20  </dd>
21</dl>
22<h2>Arguments</h2>
23<TABLE border="1" width="100%">
24  <TBODY>
25    <TR>
26<TD width="13%"><CODE>index</CODE></TD>
27<TD width="87%">Specifies the <a href="os_favorite_color_const.html">favorite color</a> color-value number to get. This index is masked with 16 colors (4 bits), which is the total number of favorite colors.</TD>
28    </TR>
29  </TBODY>
30</TABLE>
31
32<h2>Return Values</h2>
33<p>The color value of type <code><a href="../../gx/Type.html">GXRgb</a></code> that corresponds to the specified number.
34</p>
35
36<H2>Description</H2>
37<p>
38Gets the <a href="os_favorite_color_const.html">favorite color</a> color value that corresponds to the number of the <code>favoriteColor</code> member of the <code><a href="OSOwnerInfo.html">OSOwnerInfo</a></code> structure and the <CODE><a href="OSOwnerInfo.html">OSOwnerInfoEx</a></CODE> structure. <BR>
39</P>
40<h2>See Also</h2>
41<p><CODE><a href="OSOwnerInfo.html">OSOwnerInfo</a><BR> <a href="OSOwnerInfo.html">OSOwnerInfoEx</a> <br> <a href="os_favorite_color_const.html">OS_FAVORITE_COLOR_*</a><BR> <a href="OS_GetFavoriteColorTable.html">OS_GetFavoriteColorTable</a></CODE></p>
42
43<H2>Revision History</H2>
44<P>
452008/10/28 Added an explanation of the <CODE>OSOwnerInfoEx</CODE> function.<br />2004/10/08 Initial version.<br>
46</P>
47<hr><p>CONFIDENTIAL</p></body>
48</html>
49