Open Core Interface - MLPI
MLPI-MotionLogicProgrammingInterface(mlpi4COM)  1.26.2
IAxes Interface Reference

Inherits IDispatch.

Collaboration diagram for IAxes:
Collaboration graph

Properties

IAxis Item ([in] VARIANT nameOrIndex) [get]
 

Detailed Description

Definition of the IAxes interface which is a collection of IAxis objects.

Use the IAxes interface to get the references of an IAxis object. Either using the axis name or logical axis index.

Definition at line 72 of file IAxes.idl.

Property Documentation

IAxis IAxes::Item([in] VARIANT nameOrIndex)
getproperty

This property returns an IAxis object given by name of the axis or by index.

Parameters
[in]nameOrIndexEither the name (e.g. "Axis1") or the index (starting a 1) of the axis used to get the interface.
[out]axisReturns the IAxis interface of the given axis.
Returns
Return value indicating success (>=0) or error (<0).
Example C#:
...
try
{
// let's get the axis object by logical index 1 (must exist)
IAxis axis = connection.Motion.Axes[1];
// use axis object to print name of axis
Console.WriteLine(axis.GetName());
}
catch (System.Exception ex)
{
Console.WriteLine("Error: " + ex.Message);
}
Note:
This method uses the mlpiCore function mlpiMotionGetConfiguredAxes.

The documentation for this interface was generated from the following file: