QPR Knowledge Base 2016.1

GetElementID

GetElementID

Previous topic Next topic No directory for this topic  

GetElementID

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 2012

 

Returns element's ID, not supported for alerts as they do not have identifiers. Note that in the case a scorecard and its top element have the same identifier, the ID that is returned is determined in the following manner:

iResult = SCModel.GetElementId("SC123", "", outScId) returns the scorecard ID

iResult = SCModel.GetElementId("SC123", "SC123", outScId) returns the top element ID

 

Synopsis:

 

SCModel.GetElementID(SCIdentifier, ElementIdentifier, out Id)

 

Parameters:

 

SCIdentifier: String. If empty, then first object with ElementIdentifier is returned

ElementIdentifier: String

Id: Returned ID. 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_PARAMETER

RV_OBJECT_NOT_FOUND

 

Example Procedure:

 

iRet = SCModel.GetElementId("SC123", "SC123", outScId)