Parameter Access Functions

Navigation:  Libraries > CT User Programming Runtime >

Parameter Access Functions

Previous pageReturn to chapter overviewNext page
WriteUserParameter
ReadUserParameter

 

WriteUserParameter

 

The functions listed below are used to write the different parameter data types that the drive provides.

 

WriteUserParameterBIT
WriteUserParameterBOOL
WriteUserParameterDINT
WriteUserParameterINT
WriteUserParameterLREAL
WriteUserParameterSINT
WriteUserParameterUDINT
WriteUserParameterUINT
WriteUserParameterUSINT

 

These are the low level functions used by the different parameter access schemes supported by Machine Control Studio (e.g. Mxx.Pxxx or MenuName.ParameterName). There should be no reason for the user to need to use these functions except in the

 

If these functions are used, ensure that the correct function is used for the data type of the parameter being written.

 

Inputs:

 

Slot : UDINT; Set to the required slot number. Set to 0 to access a drive parameter.

 

Menu : UDINT; Set to the required menu number.

 

Parameter : UDINT; Set to the required parameter number

 

Value : The data type depends on the function being used. The last part of the function name indicates the data type to be used.; Parameter value to be written.

 

Return value: UDINT

 

 

Example in FBD:

 

WriteParameterFB

 

Example in ST:

 

VarUDINT := WriteUserParameterDINT(VarSlotUDINT, VarMenuUDINT, VarParameterUDINT, VarValueDINT); 

 

 

ReadUserParameter

 

The functions listed below are used to read the different parameter data types that the drive provides.

 

ReadUserParameterBIT
ReadUserParameterBOOL
ReadUserParameterDINT
ReadUserParameterINT
ReadUserParameterLREAL
ReadUserParameterSINT
ReadUserParameterUDINT
ReadUserParameterUINT
ReadUserParameterUSINT

 

These are the low level functions used by the different parameter access schemes supported by Machine Control Studio (e.g. Mxx.Pxxx or MenuName.ParameterName). There should be no reason for the user to need to use these functions.

 

If these functions are used, ensure that the correct function is used for the data type of the parameter being read.

 

Inputs:

 

Slot : UDINT; Set to the required slot number. Set to 0 to access a drive parameter.

 

Menu : UDINT; Set to the required menu number.

 

Parameter : UDINT; Set to the required parameter number

 

Return value: The data type of the returned value depends on the function used. The last part of the function name indicates the data type returned; Parameter value read.

 

 

Example in FBD:

 

ReadUserParameter

 

Example in ST:

 

VarValueDINT := ReadUserParameterDINT(VarSlotUDINT, VarMenuUDINT, VarParameterUDINT);