SapGuiVerifyPropertyBoolean Function


This function verifies a property of type Boolean for any SapGui control.

Include file



SapGuiVerifyPropertyBoolean( in sControlId : string, 
                             in sName      : string, 
                             in bValue     : boolean, 
                             in nOptions   : number optional,
                             in nSeverity  : number optional := SEVERITY_ERROR ) : boolean;
Parameter Description
sControlId The unique Id of the control.
sName The name of the property
bValue The value to be verified.

This parameter specifies the type of check to be performed. Available options are:

  • SAPGUI_VERIFY_EQUAL. Verifies, whether the state of the checkbox's state is equal to the value specified in the second parameter.
  • SAPGUI_VERIFY_NOT_EQUAL. Verifies, whether the checkbox's state is not equal to the value specified in the second parameter.
nSeverity Optional: Severity of the error that is raised if the verification fails. Can be one of the following values:
  • SEVERITY_SUCCESS: Success; no error (numerical value: 0)
  • SEVERITY_INFORMATIONAL: Informational; no error (numerical value: 1)
  • SEVERITY_WARNING: Warning; no error (numerical value: 2)
  • SEVERITY_ERROR: (Default) Error; simulation continues (numerical value: 3)
  • SEVERITY_TRANS_EXIT: Error; the active transaction is aborted (numerical value: 4)
  • SEVERITY_PROCESS_EXIT: Error; the simulation is aborted (numerical value: 5)

Return value

  • true if successful
  • false otherwise