SetAxisEncoder

Sets an encoder to use with an axis.

Syntax

KsError SetAxisEncoder(
     int Index,
     McEncoder Encoder
);

Parameters

Index: the index of an axis. Indexes are zero based. Aliases affect this parameter.

Encoder: selects an encoder for the axis. See the McEncoder type.

Return value

If the function succeeds, it returns errNoError, otherwise an error code. For more information about the error code, see the KsError list.

Example

Copy

KsError nRet = SetAxisEncoder(0, McEncoder::mcPrimary);

Requirements