MC_ReadBoolPar

 Function Block - Returns the value of the specified Boolean axis parameter.

Inputs

Input	Data Type	Range	Unit	Default	Description
Enable	BOOL	FALSE, TRUE	N/A	No default	Requests to read a Boolean axis parameter.
Axis	AXIS_REF	1 to 256	N/A	No default	Name of a declared instance of the AXIS_REF library function. See Axis Name and Number. See AXIS_REF Structure.
ParameterNumber	INT	-32768 to +32767	N/A	No default	Parameter number. See Axis Parameters.

Outputs

Output	Data Type	Range	Unit	Description
Valid	BOOL	FALSE, TRUE	N/A	Indicates the Value output is valid.
Busy	BOOL	FALSE, TRUE	N/A	Indicates this function block is executing.
Error	BOOL	FALSE, TRUE	N/A	Indicates an invalid input was specified.
ErrorID	INT	-32768 to +32767		Indicates the error if Error output is TRUE. See PLCopen Function Block ErrorIDs.
Value	BOOL	FALSE, TRUE	N/A	State of the Boolean parameter.

Remarks

• 
  

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

Returns the value of a drive parameter.

• The returned value has to be converted to REAL if required.
• If not possible, the vendor must provide a supplier-dependent FB for it.

See Function Blocks - General Rules about how inputs and outputs work.

Figure 1: MC_ReadBoolPar

FBD Language Example

Not available.

FFLD Language Example

IL Language Example

Not available.

ST Language Example

            (* MC_ReadBoolPar ST example *)
Inst_MC_ReadBoolPar( EnableRead, Axis1, MC_AXIS_PARAM_IN_POSITION );
Axis1InPosition := Inst_MC_ReadBoolPar.Value;