Lets the developer clear the persistent state of a form.

Syntax:

FormStateClear (user state identifier)

Parameters:

user state identifier –

The reserved form names listed below will provide the following functionality:

'' – A blank string will clear the state of the current form.

'*' – The asterisk character will clear the persistent state of all forms of the current project.

Returns:

The function returns True if the persistent state of the specified form exists; otherwise, it returns False.

Uses:

The main use of this function is to provide the end user with a Restore Default option for a given form.

Note:

Only the '' and '*' values are supported. Using a user state identifier of '' will clear the state of the current form and all of its subforms and their subforms.

To clear all the data, you can also delete the user state file. The user state file is saved at:

C:\Documents and Settings\<user>\Application Data\MSE\<APP GUI ID>\

In Windows 7 and Windows 8, the file is created at:

C:\Users\<user>\AppData\Roaming\MSE\<APP GUI ID>

This function is supported for Online and Rich Client tasks and is a client-side function. (For Rich Client: Since version: 1.9)

Platform specific:

This function is not supported for mobile devices.

See also:

Persistent Form State

The Online and Rich Client Samples projects (program IF07 and RIF07)