Please enable JavaScript to view this site.

QPR Knowledge Base 2023.1

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

    GetFormula

    Scroll Prev Top Next More

    Revision history:

    Introduced in QPR 7.2.1

    Last changed in QPR 2012

     

    Gets the formula that is set for the element-series combination defined in the function call.

     

    Synopsis:

     

    SCModel.GetFormula(ElementId, SeriesIdentifier, outFormula)

     

    Parameters:

     

    ElementId: Integer.

    SeriesIdentifier: String. Must be identifier of some series that belongs to ElementId

    Formula: String. Contains the returned formula.

     

    Required Rights:

     

    Administrator or Model Administrator rights to the SCModel.

     

    Return Values:

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

     

    RV_SUCCESS

    RV_MODEL_NOT_OPEN

    RV_NO_RIGHTS

    RV_ELEMENT_NOT_FOUND

    RV_INVALID_PARAMETER

    RV_SERIES_NOT_FOUND

    RV_SERIES_DOES_NOT_HAVE_FORMULA

    RV_UNKNOWN_ERROR

     

    Example Procedure:

     

    iResult = SCModel.GetFormula(id, "act", Formula)