PA_SetMenuIcon

version 2003

PA_SetMenuIcon (params; id)

Parameter	Type		Description
params	PA_PluginParameters	→	Parameters received in PluginMain
id	short	→	ID of a 'cicn' resource

Description

The routine PA_SetMenuIcon gives 4th Dimension the ID of a 'cicn' resource that will appear beside the area name in the tools palette plug-in area pop-up.


   
    params

is the


   PA_PluginParameters

the plug-in received in its


   PluginMain

routine.

ID

is the unique ID of a resource of type 'cicn', in the resource fork of the plug-in.

This routine must be called when PA_GetAreaEvent returns eAE_GetMenuIcon . Otherwise, it does nothing and PA_GetLastError returns eER_BadEventCall .

Example

   PA_AreaEvent   event = PA_GetAreaEvent(params);
   if(event ==  eAE_GetMenuIcon)
      PA_SetMenuIcon( 15678 );

See Also

No reference.

Error Handling

Use PA_GetLastError to see if an error occurred ( eER_BadEventCall )