MC_GrpReadParam

 Function Block - Reads a value from the specified group parameter.

Inputs

Input	Data Type	Range	Unit	Default	Description
Enable	BOOL	FALSE, TRUE	N/A	No default	If TRUE, then request to read a value from the specified Boolean group parameter.
AxesGroupRef	AXES_GROUP_REF	No range	N/A	No default	The axis group the Boolean parameter value is read from.
ParamNum	LREAL	See Axes Group Parameters.	LREAL	No default	Currently, one parameter is supported: MC_GRP_PARAM_CIRCLE_TOLERANCE: ID = 2000 The value read is the axes group circle construction tolerance. See Axes Group Parameters.

Outputs

Output	Data Type	Range	Unit	Description
Done	BOOL	FALSE, TRUE	N/A	If TRUE, the command completed successfully.
Error	BOOL	FALSE, TRUE	N/A	If TRUE, an error has occurred.
ErrorID	INT	No range	N/A	Indicates the error if Error output is TRUE. See PLCopen Function Block ErrorIDs.
ParamValue	UINT	No range	N/A	The value of the group parameter.

Remarks

• 
  

• This function or function block returns cached data.
  See Program a Multi-Core Controller.

• See Coordinated Motion, the top-level topic for Coordinated Motion.
• See Function Blocks - General Rules about how inputs and outputs work.

Figure 1: MC_GrpReadParam

FBD Language Example

FFLD Language Example

IL Language Example

Not available.

ST Language Example

Inst_MC_GrpReadParam( DoEnable, Group1_ref, MC_GRP_PARAM_CIRCLE_TOLERANCE );       
CircleTolerance := Inst_MC_GrpReadParam.ParamValue;

See Also

• MC_ErrorDescription
• MC_GrpWriteParam