resetAllCtls

Requires FM 1.0 Beta 8.5 (15 Nov 2007) or newer

Syntax

bool resetAllCtls()

Return

Returns true if the function succeeded, or false if the internal RedrawWindow Win32 API call failed for some reason.

Description

Resets the entire plugin user interface back to the default state when FilterMeister is loaded without any code. This deletes any controls you may have created in your code previously, and even re-initializes the built-in strings like the Dialog Title, the Filter Author, Copyright & Version strings, and resets the background image and drag-mode of the dialog.
NB: This function might not be intended for use by the filter developer. It has never been publicly documented in any release notes. However, it has been accessible to the filter developer ever since FM 1.0 Beta 8.5 in November 2007.

Example

%ffp

ctl[2]: STANDARD, Text="This will vanish in about 2 seconds"

OnFilterStart: {
  sleep(2000);
  resetAllCtls();
  return true;
}

See Also

deleteCtl

Comments

Note that this function is broken in FM 1.0 Beta 9g. It incorrectly expects a single argument to be passed, even though this function does not accept any arguments.