RtecatSetAxisCustomName

RtecatSetAxisCustomName sets a custom name for an axis.

Syntax

Copy

RTECAT_ERROR RtecatSetAxisCustomName(
  [in]    RTECAT_HANDLE Axis,
  [in]    const wchar_t* pName
);

Parameters

[in] Axis

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

[in] pName

A custom name for the 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 pName is NULL.
ecatErrWrongParameter	One of the following conditions occurred: Parameter Axis is invalid. The length of parameter pName is greater than 63.
ecatErrMainDeviceNotReady	The MainDevice is not ready.
ecatErrWrongEnvironment	The MainDevice has not started.

Remarks

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