Legacy Document

Inside Macintosh: Macintosh Toolbox Essentials /

Chapter 3 - Menu Manager / Menu Manager Reference

Menu Manager Routines / Managing Entries in the Menu Color Information Table

GetMCEntry

Use the GetMCEntry function to return information about an entry in your application's menu color information table. You can get information about the menu bar entry, a menu title entry, or a menu item entry.

FUNCTION GetMCEntry (menuID: Integer; menuItem: Integer)
                    : MCEntryPtr; 

menuID

The menu ID that the GetMCEntry function should use to return information about the menu color information table. Specify 0 in the menuID parameter (and the menuItem parameter) to get the menu bar entry. Specify the menu ID of a menu in the current menu list in the menuID parameter and 0 in the menuItem parameter to get a specific menu title entry. Specify the menu ID of a menu in the current menu list in the menuID parameter and an item number in the menuItem parameter to get a specific menu item entry.

menuItem

The menu item that the GetMCEntry function should use to return information about the menu color information table. If you specify 0 in this parameter, GetMCEntry returns either the menu bar entry or the menu title entry, depending on the value of the menuID parameter. If you specify the item number of a menu item in this parameter and the menu ID of a menu in the current menu list in the menuID parameter, GetMCEntry returns a specific menu item entry.

DESCRIPTION

The GetMCEntry function returns a menu bar entry, a menu title entry, or a menu item entry according to the values specified in the menuID and menuItem parameters. If
the GetMCEntry function finds the specified entry in your application's menu color information table, it returns a pointer to a record of data type MCEntry. If the specified entry is not found, GetMCEntry returns NIL.

WARNING

The menu color information table is relocatable, so the pointer returned by the GetMCEntry function may not be valid across routines that may move or purge memory. Your application should make a copy of the menu color entry record if necessary.

SEE ALSO

"The Menu Color Information Table Record" beginning on page 3-100 describes the entries in a menu color information table.