Please enable JavaScript to view this site.

QPR Knowledge Base 2019.1

Navigation: Developer's Guide > QPR API > The Object Model > QPR Metrics > SCApplication Commands

GetModels

Scroll Prev Top Next More

Revision history:

Introduced in QPR 7.2.1

 

Fills the Models parameter with an array with the following columns:

model name

id

description

replyaddress

archived flag (1=model is archived, 0=model is not archived)

 

Synopsis:

 

SCApplication.GetModels(out Models)

 

Parameters:

 

Models: pointer to variant array. The array has one row for each model and the rows contain the following columns:

Model name, string

Model ID, integer

Model description, string

Reply address, string

Flag for whether the model is archived, boolean (0 = false, 1 = true)

 

Required Rights:

 

View. If the user does not have rights to a model, it is not returned

 

Return Values:

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

 

RV_APPLICATION_QUIT_CALLED

RV_NOT_CONNECTED_TO_SERVER

RV_NOT_AUTHENTICATED

RV_SUCCESS

RV_UNKNOWN_ERROR

RV_NO_DATA

 

Example Procedure:

 

iRet = SCApplication.GetModels(Models)