Configure

Far Manager

previous page next page

Configure

The Configure function allows the user to configure the plugin module. It is called when one of the items exported by this plugin to the "Plugin configuration" menu is selected.

int WINAPI Configure(
  int ItemNumber
);

Parameters

ItemNumber

The number of selected item in the list of items exported by this plugin to the "Plugin configuration" menu.

Return value

If the function succeeds, the return value must be TRUE - in this case FAR updates the panels. If the configuration is canceled by user, FALSE should be returned.

Remarks

If your plugin exports only one menu item then you can ignore ItemNumber.

Example

int WINAPI _export Configure(int ItemNumber)
{
  switch(ItemNumber)
  {
    case 0:
      return(Config());
  }
  return(FALSE);
}