Axis_Group_Description

Read Axis or Group Description. More...

Collaboration diagram for Axis_Group_Description:

Functions
RTN_ERR FNTYPE	NMC_AxisGetDescription (I32_T DevID, I32_T AxisIndex, U32_T DescStrSize, char *PRetAxisDescription)
	Read the name description information of the specified axis. More...
RTN_ERR FNTYPE	NMC_GroupGetDescription (I32_T DevID, I32_T GroupIndex, U32_T DescStrSize, char *PRetGroupDescription)
	Read the name desciption information of the specified group. More...

Detailed Description

Read Axis or Group Description.

Function Documentation

RTN_ERR FNTYPE NMC_AxisGetDescription	(	I32_T	DevID,
		I32_T	AxisIndex,
		U32_T	DescStrSize,
		char *	PRetAxisDescription
	)

Read the name description information of the specified axis.

Parameters

DevID	Device ID (DevID)
AxisIndex	The specified axis index to be read from
DescStrSize	C-style string buff size, in byte
PRetAxisDescription	Given C-style string buff and return description

Returns

Return an error code.
If the function is called successfully, the return value is ERR_NEXMOTION_SUCCESS (0). Otherwise, the return value is an error code. All error codes are defined in the header file, NexMotionError.h.

Usage:
This function is used to read the name description of the specified axis. The information source is based on the NCF file loaded byh the system, so it must be loaded before it can be read normally. In other words, the system state must be in READY state.

Reference:

RTN_ERR FNTYPE NMC_GroupGetDescription	(	I32_T	DevID,
		I32_T	GroupIndex,
		U32_T	DescStrSize,
		char *	PRetGroupDescription
	)

Read the name desciption information of the specified group.

Parameters

DevID	Device ID (DevID)
GroupIndex	The specified group index to be read from
DescStrSize	C-style string buff size, in byte
PRetGroupDescription	Given C-style string buff and return description

Returns

Return an error code.
If the function is called successfully, the return value is ERR_NEXMOTION_SUCCESS (0). Otherwise, the return value is an error code. All error codes are defined in the header file, NexMotionError.h.

Usage:
This function is used to read the name description of the specified group. The information source is based on the NCF file loaded byh the system, so it must be loaded before it can be read normally. In other words, the system state must be in READY state.

Reference: