OS_GetFavoriteColor

Syntax

#include <nitro/os.h>

static inline GXRgb OS_GetFavoriteColor(int index);

Arguments

index Specifies the favorite color color-value number to get. This index is masked with 16 colors (4 bits), which is the total number of favorite colors.

Return Values

The color value of type GXRgb that corresponds to the specified number.

Description

Gets the favorite color color value that corresponds to the number of the favoriteColor member of the OSOwnerInfo structure and the OSOwnerInfoEx structure.

See Also

OSOwnerInfo
OSOwnerInfoEx
OS_FAVORITE_COLOR_*
OS_GetFavoriteColorTable

Revision History

2008/10/28 Added an explanation of the OSOwnerInfoEx function.
2004/10/08 Initial version.

CONFIDENTIAL