GetPluginInfo

Far Manager

previous page next page

GetPluginInfo

The GetPluginInfo function is called to get general plugin information.

void WINAPI GetPluginInfo(
  struct PluginInfo *Info
);

Parameters

Info

Points to a PluginInfo structure that should be filled by this function. The plugin must fill this structure.

Return value

None.

Remarks

This function is called before the following actions:
- before the plugins configuration menu is shown
- before the plugin commands menu (F11) is shown
- before the disks menu (Alt-F1/Alt-F2) is shown
- when a command with a prefix is entered in the command line (for example, net:\\share).
Because this function gets called frequently, time consuming operations should not be done within it.
The PluginInfo structure passed to this function is already filled with zeros. The plugin is required to fill the StructSize field of the structure.
FAR calls GetPluginInfo function rather often, therefore it is necessary to minimize "computations" performed by this function when developing a plugin.

Example

void WINAPI _export GetPluginInfo(struct PluginInfo *Info)
{
  Info->StructSize=sizeof(struct PluginInfo);
  Info->Flags=PF_EDITOR|PF_DISABLEPANELS;

  static char *PluginMenuStrings[1];
  PluginMenuStrings[0]=GetMsg(MBrackets);

  Info->PluginMenuStrings=PluginMenuStrings;
  Info->PluginMenuStringsNumber=sizeof(PluginMenuStrings)/
             sizeof(PluginMenuStrings[0]);
}