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

    SetModelProperty

    Scroll Prev Top Next More

    Revision history:

    Introduced in QPR 7.4.1 SP5

     

    Sets a property value for the model property specified in the function call.

     

    Synopsis:

     

    SCModel.SetModelProperty(PropertyName, Value)

     

    Parameters:

     

    PropertyName: String. Name of the property for which the value will be set. Supported properties:

    ModelArchived: Boolean. Defines whether the model is archived. True = archived, False = not archived.

    Value: Variant. Variant specifying the new property value.

     

    Required Rights:

     

    Administrator or model administrator.

     

    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_MODEL_NOT_OPEN

    RV_SUCCESS

    RV_NO_RIGHTS

    RV_PROPERTY_NOT_SUPPORTED

    RV_NO_DATA

    RV_UNKNOWN_ERROR

     

    Example Procedure:

     

    iRet = SCModel.SetModelProperty("ModelArchived", TRUE)