QPR Knowledge Base 2015.1

GetProperty

GetProperty

Previous topic Next topic No directory for this topic  

GetProperty

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

Revision history:

Introduced in QPR 7.3.1

 

Fetches one of the following Application properties:

NAME: Returns a string containing the application's name in the Value parameter. For example "QPR Metrics".

VERSION: Returns full version as a string. For instance "7.3.1.27".

EXEPATH: EXE file's full path as a string, e.g. "C:\Program Files\QPR Software Plc\QPR 2015 Clients\Metrics\QPR.Metrics.Client.exe"

 

Synopsis:

 

SCApplication.GetProperty(PropertyName, out Value)

 

Parameters:

 

PropertyName: String. One of the three properties described above.

out Value: Variant. Variant for the returned value.

 

Required Rights:

 

None.

 

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_INVALID_PARAMETER

 

Example Procedure:

 

iRet = SCApplication.GetProperty("NAME", ApplicationName)