SetGroupParameter

Sets the value of a vendor-specific parameter for an axis group. The parameters are defined in McAxisParameter.

Syntax

KsCommandStatus SetGroupParameter(
     int Index,
     McGroupParameter ParameterNumber,
     double Value,
     McExecutionMode ExecutionMode
);

Parameters

Index [in]: the index of an axis group. Indexes are zero based. Aliases affect this parameter. You can have up to 32 groups.

ParameterNumber [in]: a parameter in the McGroupParameter type.

Value [in]: writes the value to the parameter you picked from theMcGroupParameter type. For example, if you pick mcMaxVelocityACS in McGroupParameter, you need to write its value here.

ExecutionMode [in]: defines the chronological sequence of the function. See the McExecutionMode type.

Return value

Returns the KsCommandStatus structure.

Example

N/A

Requirements

  RT Win32
Minimum supported version 4.0 4.0
Header ksmotion.h ksmotion.h
Library KsApi_Rtss.lib KsApi.lib

See also

GetGroupParameter