IForeMethodParam.Description

Syntax

Description: String;

Description

The Description property determines the parameter description.

Example

Executing the example requires that the repository contains an area of the global parameters with the SHARED_P identifier.

Sub Main;

Var

mb: IMetabase;

Shp: ISharedParams;

UserMeth: IForeMethods;

uMethod: IForeMethod;

MethParams: IForeMethodParams;

mParam: IForeMethodParam;

Begin

mb := MetabaseClass.Active;

Shp := mb.ItemById("SHARED_P").Bind As ISharedParams;

UserMeth := Shp.Methods;

uMethod := UserMeth.FindByKey(1);

If uMethod <> Null Then

uMethod.Bind;

MethParams := uMethod.Params;

mParam := MethParams.FindByParam("PARAM_1");

If mParam <> Null

Then mParam.Description:= "Parameter description";

Else Debug.WriteLine("Parameter is not found");

End If;

End If;

End Sub Main;

After executing the example the search of the PARAM&1 parameter at the custom method with the key 1 is executed. If parameter is found, its description will be changed.

See also:

IForeMethodParam