QPR Knowledge Base 2016.1

GetActive

GetActive

Previous topic Next topic No directory for this topic  

GetActive

Previous topic Next topic Topic directory requires JavaScript Mail us feedback on this topic!  

Revision history:

Introduced in QPR 7.2.1

Last changed in QPR 7.3.1

 

Returns the ID of the selected item that is active in the user interface. This command is applicable only to the Navigator view of the Scorecard Explorer window with focus in the QPR Metrics client.

 

Synopsis:

 

SCModel.GetActive(ActiveType, OutID)

 

Parameters:

 

ActiveType: String. The type of the active element wanted. Currently supported types are SCORECARD, ELEMENT, MODEL, USER, and CURRENTPERIOD. CURRENTPERIOD returns an array of current periods with the following structure:

PeriodLevelId

PeriodLevel Name

Period ID (current period)

OutID: Variant for storing the ID of the returned element. Integer.

 

Required Rights:

 

None.

 

Return Values:

Below are listed the return values that this function can return:

 

RV_SUCCESS

RV_MODEL_NOT_OPEN

RV_INVALID_ELEMENT_TYPE

RV_ELEMENT_NOT_FOUND

 

Example Procedure:

 

iResult = SCModel.GetActive("SCORECARD", Id)