Session information

The Genero BDL API for GGC provides functions for retrieving information about sessions.

The following functions allow you to retrieve information from the current session.

Functions getStatistics() or showStatistics() return values in a ggc.Statistics record type.

Table 1. Functions for retrieving session information
Function Description 
getApplicationName() 
  RETURNS STRING
 Retrieve the application name. 
getChildCount()
  RETURNS INTEGER
 Retrieve the number of running child applications. 
getSessionId()
  RETURNS STRING
 Get the current session identifier. 
getState()
  RETURNS STRING
 Retrieve the application state. 
getStatistics()
  RETURNS Statistics
 Retrieve the test session statistics. 
notifyCheckFailure( message STRING )
Report a check failure. 
notifyCheckFailureEx(  
        fileName STRING,
        lineNo INTEGER,
        message STRING )
Report a check failure, and provide the error information: filename, line number, and error message. 
notifyFailure( message STRING )
Report a scenario failure. 
notifyFailureEx(
        fileName STRING,
        lineNo INTEGER,
        message STRING
Report a scenario failure, and provide the error information: file name, line number, and error message. 
showStatistics()
  RETURNS Statistics
 Show test statistics. 
parseOptions()
Fill a dynamic array with program arguments.