Exported functions
FAR Manager communicates with its plugins by a set of functions
exported by the plugins. A plugin does not need to export all functions listed below.
Implement only those that are required by the functionality of the plugin.
Attention!
- All file names passed to FAR must be in OEM code page. FAR also passes file names in OEM code page. Before calling plugin functions FAR calls SetFileApisToOEM. If plugin uses anywhere SetFileApisToANSI, it must call SetFileApisToOEM again before returning control to FAR.
Common functions
| Function | Description |
|---|---|
| Configure | plugin configuration |
| ExitFAR | before closing the FAR Manager |
| GetMinFarVersion | get mininum FAR Manager version |
| GetPluginInfo | get plugin information |
| SetStartupInfo | global settings |
File panel specific functions
| Function | Description |
|---|---|
| ClosePlugin | before closing an open plugin instance. |
| Compare | overrides sorting algorithm |
| DeleteFiles | delete files |
| FreeFindData | frees memory, allocated by GetFindData |
| FreeVirtualFindData | frees memory, allocated by GetVirtualFindData |
| GetFiles | get files |
| GetFindData | get file list |
| GetOpenPluginInfo | get information about an open plugin instance |
| GetVirtualFindData | get files |
| MakeDirectory | make a directory |
| OpenFilePlugin | open a file |
| OpenPlugin | create a new plugin instance |
| ProcessEvent | process events |
| ProcessHostFile | execute archive commands |
| ProcessKey | process keyboard events |
| PutFiles | put files to the emulated file system |
| SetDirectory | set current directory in the emulated file system |
| SetFindList | transfers found files from the "Find file" dialog to the emulated file system |
Editor specific functions
| Function | Description |
|---|---|
| ProcessEditorInput | process keyboard events |
| ProcessEditorEvent | process editor events |
Viewer specific functions
| Function | Description |
|---|---|
| ProcessViewerEvent | process viewer events |
Dialog specific functions
| Function | Description |
|---|---|
| ProcessDialogEvent | Process dialog events |
See also: