QPR Knowledge Base 2016.1

GetModelProperty

GetModelProperty

Previous topic Next topic No directory for this topic  

GetModelProperty

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

Revision history:

Introduced in QPR 7.4.1 SP3

Last changed in QPR 2014.1

 

Returns the value of the model property defined in the function call.

 

Synopsis:

 

PGModel.GetModelProperty(PropertyName, OutValue)

 

Parameters:

 

PropertyName: String. Name of the property for which the value is requested. Supported properties:

ModelPublished: Returns True or False depending on whether the model is published in QPR Portal.

HideUnusedBaseModelElements: Returns True or False depending on whether model is set to ignore all unused base model elements.

VersionNumber: String. Returns the model's version information Version Number as string.

Author: String. Returns the model's version information Author as string.

Comment: String. Returns the model's version information Comment as string.

Status: Int (enum). Returns the model's version information Status as enumeration index value (integer). Default model enumerations: Draft = 0, Current State = 1, Proposal = 2, Approved = 3, Implemented = 4

LastChanged: DateTime. Returns the model's version information Last Changed as date time.

ModelCreated: DateTime. Returns the model's version information Model Created as date time.

LastSaved: DateTime. Returns the model's version information Last Saved as date time.

ModelVersionManagement: Int (enum). Returns the model's version management status as enumeration index value (integer). Supported values: 0 = version management disabled, 1 = save changes to the current version, 2 = save as new model version, 3 = prompt.

ChildModels: Returns an array containing the id(s), name(s) and path(s) of the model's child model(s).

BaseModel: Returns an array containing the id, name and path of the model's base model.  If the model does not use a base model, returned values are: id: 0, name and path: empty

OutValue: Variant returning the requested property value.

 

Required Rights:

 

At least view rights to model.

 

Return Values:

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

 

RV_SUCCESS

RV_APPLICATION_QUIT_CALLED

RV_MODEL_NOT_OPEN

RV_INVALID_PARAMETER

RV_UNKNOWN_ERROR

 

Example Procedure:

 

iResult = PGModel.GetModelProperty("ModelPublished", OutVal)