sfGetFormStatus
Returns the form status of the current form. Each form status relates to one of the system statuses: Open, Completed and Rejected with codes OPEN, COMP and REJ respectively. This function can be used to get the form status name or the related system status.
Syntax
sfGetFormStatus(returnFullName)
Parameters
Name | Type | Mandatory | Description |
|---|---|---|---|
returnFullName | boolean | no | Set true to get the actual form status name and false to get the related system status. If no value is passed, it is considered as false and the system status is returned. |
Usage examples
Example 1
Let us assume a form at status “Pending review” whose related system status is OPEN. The system status code of the form can be obtained using,
sfGetFormStatus()or
sfGetFormStatus(false)Here, the function returns the string OPEN.
Example 2
Consider the example form above. The form status name can be obtained using,
sfGetFormStatus(true)Here, the function returns the string Pending review.