PA_GetAreaName

version 2003

PA_GetAreaName (params; name)

Parameter	Type		Description
params	PA_PluginParameters	→	Parameters received in PluginMain
name	char*	←	Sting buffer to the name of the area

Description

The routine PA_GetAreaName returns the name of the area in the string buffer name . It is the name of the variable used by the 4D developer in the Design environment.


   
    params

is the


   PA_PluginParameters

the plug-in received in its


   PluginMain

routine.


 
  name

will never contain the interprocess sign ("<>" under Windows and the diamond under MacOS), but the plug-in can retreive this info in the plug-in properties by reading the


 fInterProcessVariable

field of the


 
  PA_PluginProperties

structure.

Depending on default settings or on previous calls to PA_UsePStrings or PA_UseCStrings , name will be a Pascal or an ANSI C string.

Example

Getting all area info, events, properties.

   void GetAreaStuff(PA_PluginParameters params,
                  AE_AreaEvent *event,
                  char *name,
                  PA_Rect *rect,
                  PA_PluginProperties *props)
   {
      if(event)
         *event = PA_GetAreaEvent(params);
      if(name)
         PA_GetAreaName(params, name);
      if(rect)
         *rect = PA_GetAreaRect(arams);
      if(props)
         PA_GetPluginProperties(params, props);
   }

Error Handling


 
  
   PA_GetLastError

keeps the last error that occurred before calling the routine.