RtecatWriteAxisCustomOutput2

RtecatWriteAxisCustomOutput2 writes the second custom output variable of an axis.

Syntax

Copy
RTECAT_ERROR RtecatWriteAxisCustomOutput2(
  [in]    RTECAT_HANDLE Axis,
  [in]    DWORD Value
);

Parameters

[in] Axis

A handle to an axis. To retrieve the corresponding handle, use RtecatOpenAxisByIndex or RtecatOpenAxisByLocation.

[in] Value

A DWORD value to write that represents the second custom output variable 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.

ecatErrWrongParameter

Parameter Axis is invalid.

ecatErrMainDeviceNotReady

The MainDevice is not ready.

ecatErrWrongEnvironment

The link has not started.

ecatErrVariableUnavailable

The device does not support writing the second custom output variable.

Remarks

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

See Also: