GetParameter Method

Retrieve the parameter specified by parameterId as a Parameter object.

Syntax

public Parameter GetParameter( 
   System.string parameterId,
   System.bool checkReportLevel
)

Parameters

parameterId: The ID (Name) of the parameter to retrieve.
checkReportLevel: If True, Exago will also check for report level parameters with the same parameterId. Defaults to True. Exago will check the currently Active report.

Return Value

A Parameter object that represents the requested parameter. If no parameter with the requested paramerId is found, returns null.

Example

//Built-in system parameters
Parameter user = api.Parameters.GetParameter("userId");
Parameter company = api.Parameters.GetParameter("companyId");

//A custom parameter named AssetValue
Parameter aValue = api.Parameters.GetParameter("AssetValue");

Parameters

Return Value

Reference