Carbon


GetMenuItemPropertySize

Header: Menus.h Carbon status: Supported

Obtains the size of a piece of data that has been previously associated with a menu item.

OSStatus GetMenuItemPropertySize (
    MenuHandle menu, 
    UInt16 item, 
    OSType propertyCreator, 
    OSType propertyTag, 
    UInt32 *size
);
menu

A handle to the menu containing the item to be examined for associated data.

item

The item number of the menu item or 0 if the data is associated with the menu as a whole.

propertyCreator

A four-character code. Pass your program’s signature, as registered through Apple Developer Technical Support. If your program is of a type that would not normally have a signature (for example, a plug-in), you should still register and use a signature in this case, even though your program’s file may not have the same creator code as the signature that you register. The 'macs' property signature is reserved for the system and should not be used.

propertyTag

A four-character code. Pass the application-defined code identifying the data.

size

On input, a pointer to an unsigned 32-bit integer. On return, this value is set to the actual size of the data.

function result

A result code.

DISCUSSION

If you want to retrieve a piece of associated data with the function GetMenuItemProperty, you will typically need to use the GetMenuItemPropertySize function beforehand to determine the size of the associated data.

VERSION NOTES

This function is available with Mac OS 8.5 and later.

AVAILABILITY

Supported in Carbon. Available in CarbonLib 1.0 and later when MenusLib 8.5 or later is installed. Exported by CarbonLib 1.0 and later and by MenusLib 8.5 and later.


© 2000 Apple Computer, Inc. — (Last Updated 4/14/2000)