Salesforce

SetParam (Magic xpa 3.x)

« Go Back

Information

 
Created ByKnowledge Migration User
Approval Process StatusPublished
Objective
Description

SetParam (Magic xpa 3.x)

Sets the value of a global parameter. The value is set for a single (current) context.

A global parameter is a named variable, not defined in any task.

Syntax:

SetParam (parameter name, value)

Parameters:

parameter name: A string representing the name of a global parameter.

value: A value that can be returned.

Returns:

Boolean value indicating success or failure.

Examples:

SetParam('P-Employee name', BA)
The variable BA contains a string value to be passed as a parameter.

SetParam('Param-name','') removes the global parameter from the current context.

SetParam('P_DATE',EOM()+1) creates a variable in the memory called P_DATE, which is a Date variable containing the value of the 1st day of the next month. You can then use the expression GetParam('P_DATE') to initiate date fields with the value from memory instead of using the same expression again. Think of it as a new way to send parameters between two (or more) programs.

A call to SetParam ('*','') clears all known parameters in a context. Since version: 1.9j

See also:

GetParam

SharedValGet

SharedValSet

SpecialSetParamRemoveEmptyStrings

The Online and Rich Client Samples projects (program TF10 and RTF10)

Reference
Attachment 
Attachment