RtecatOpenAxisByLocation

RtecatOpenAxisByLocation opens the axis by its location.

Syntax

Copy

RTECAT_ERROR RtecatOpenAxisByLocation(
  [in]    RTECAT_HANDLE SubDevice,
  [out]   RTECAT_HANDLE* pAxis,
  [in]    INT SlotId  
);

Parameters

[in] SubDevice

A handle to a SubDevice. To retrieve the corresponding handle, use RtecatOpenSubDeviceByIndex, RtecatOpenSubDeviceByStationAddress, or RtecatOpenSubDeviceByExplicitId.

[out] pAxis

A pointer to an axis handle.

[in] SlotId

The index of a slot.

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	Parameter SubDevice or SlotId is invalid.
ecatErrMainDeviceNotReady	The MainDevice is not ready.
ecatErrWrongEnvironment	The link has not started.

Remarks

RtecatOpenAxisByLocation 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)