GetPar - method of the PmaObject object
Description:
Reading the value
of the Pma object parameter.
If this parameter is not present in this object, then the parents of this object are searched for it and if not found the search continues up to the
PmaRoot object.
Syntax:
Variant GetPar(String sPar, [Long nAttr])
Parameters:
| sPar | (String) The parametr name (case sensitive text). |
|---|
| nAttr | [optional] (Long) Additional attributes for detecting parameter.
0 (default) - Return value is of the String type.
1 - Return value is of the Long type.
If the value cannot be converted into an integer then the method returns the NaN value (it can be tested by the Pm.IsValid method). |
|---|
Return value:
Returns a value of the
Pma object parameter.
If an error occures, then the method returns:
null for
JavaScript or
Empty for
VBScript (it can be tested by the
Pm.IsValid method).
Example:
Reads the value of the abc parameter.
This parameter can be defined in oObject Pma object or in its parents.
JavaScriptVBScriptSelect and copy to clipboard
var x = oObject.GetPar("abc");
Dim x
x = oObject.GetPar("abc")