ContentStopGetValue

From TotalcmdWiki
Revision as of 15:24, 15 April 2017 by Lefteous (talk | contribs) (Initial document version, backlink & category)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

ContentStopGetValue is called to tell a plugin that a directory change has occurred, and the plugin should stop loading a value.

Declaration:

void __stdcall ContentStopGetValue(char* FileName);

Description of parameters:

FileName The name of the file for which ContentGetValue is currently being called.

Return value:

The function has no return value.

Note:

This function only needs to be implemented when handling very slow fields, e.g. the calculation of the total size of all files in a directory. It will be called only while a call to ContentGetValue is active in a background thread. A plugin could handle this mechanism like this: 1. When ContentGetValue is called, set a variable GetAborted to false 2. When ContentStopGetValue is called, set GetAborted to true 3. Check GetAborted during the lengthy operation, and if it becomes true, return ft_fieldempty


Back to Content plugins developer guide