Load Memory Object Description

NI-Motion VI

previous page next page

Load Memory Object Description

Loads an ASCII text description for a program or buffer object.

Device Compatibility

Device	Compatibility
7330	N
7340	Y
7344	Y
7350	Y
7390	N
NI SoftMotion Controller for CANopen—Accelnet	N
NI SoftMotion Controller for CANopen—Xenus	N

Description is an ASCII character array of up to 32 characters that describes the object.

Board ID is a unique number assigned by Measurement & Automation Explorer (MAX) used to send and receive commands and data to or from a specific NI motion controller.

Object (1) is a program or buffer stored in onboard RAM.

error in (no error) describes error conditions that occur before this VI runs. The default input of this cluster is no error. If an error already occurred, this VI returns the value of error in in error out. The VI runs normally only if no incoming error exists. Otherwise, the VI passes the error in value to error out. The error in cluster contains the following parameters:

	status is TRUE if an error occurred before this VI was called, or FALSE if not. If status is TRUE, code is a nonzero error code. If status is FALSE, code is zero or a warning code.
	code is a number identifying an error or warning. If status is TRUE, code is a nonzero error code. If status is FALSE, code is zero or a warning code. Use the error handler VIs to look up the meaning of this code and display the corresponding error message.
	source is a string that indicates the origin of the error, if any. Typically, source is the name of the VI in which the error occurred.

Bd ID Out is provided for flow control. You can string together NI-Motion VIs by wiring the Bd ID Out terminal of one VI to the Board ID terminal of the next VI.

Resource Out is the Axis, Vector Space, ADC, or Encoder you wired into the VI. Use Resource Output to pass the resource to another VI and/or to display information about the device.

error out contains error information. If error in indicates an error, error out contains the same error information. Otherwise, it describes the error status that this VI produces.

	status is TRUE if an error occurred, or FALSE if not. If status is TRUE, code is a nonzero error code. If status is FALSE, code is zero or a warning code.
	code is a number identifying an error or warning. If status is TRUE, code is a nonzero error code. If status is FALSE, code is zero or a warning code. Use the error handler VIs to look up the meaning of this code and display the corresponding error message.
	source is a string that indicates the origin of the error, if any. Typically, source is the name of the VI in which the error occurred.

Using This VI

The Load Memory Object Description VI loads a text description for a program or buffer object. The ASCII text description is useful as a quick reminder of the contents or purpose of an object stored in memory.

Note This VI must be executed while the object is still in RAM. After the object is saved to ROM, its description cannot be changed.

The description is limited to 32 characters; extra characters are ignored. You can retrieve the stored description with the Read Memory Object Description VI.

previous page start next page