RtecatOpenAxisByIndex

RtecatOpenAxisByIndex opens the axis by its index.

Syntax

Copy

RTECAT_ERROR RtecatOpenAxisByIndex(
  [in]    RTECAT_HANDLE MainDevice,
  [out]   RTECAT_HANDLE* pAxis,
  [in]    ULONG Index  
);

Parameters

[in] MainDevice

A handle to a MainDevice. To retrieve the corresponding handle, use RtecatCreateMainDevice or RtecatOpenMainDevice.

[out] pAxis

A pointer to an axis handle.

[in] Index

The index of an axis.

Return Values

The function returns an RTECAT_ERROR value. If the function succeeds, it returns ecatErrNoError. If the function fails, it returns a different value.

Possible return values:

Return value	Meaning
ecatErrNoError	The function succeeded.
ecatErrNullParameter	Parameter pAxis is NULL.
ecatErrWrongParameter	One of the following conditions occurred: Parameter MainDevice is invalid. Parameter Index is out of range.
ecatErrMainDeviceNotReady	The MainDevice is not ready.
ecatErrWrongEnvironment	The link has not started.

Remarks

RtecatOpenAxisByIndex is a synchronous function that executes immediately and returns a result upon completion.

Requirements

Minimum supported version	Header	Library
wRTOS 1.0 SDK	RtecatApi.h	RtecatApi_W64.lib (Windows), RtecatApi.lib (RTSS)