flex_load_description |
Load Memory Object Description
Usage
status = flex_load_description(u8 boardID, u8 object, i8* description);
Purpose
Loads a ASCII text description for a program or buffer object.
Parameters
| Name | Type | Description |
|---|---|---|
| boardID | u8 | assigned by Measurement & Automation Explorer (MAX) |
| object | u8 | program or other memory object |
| description | [i8]* | ASCII character array describing the object |
Parameter Discussion
object is a program or buffer object stored in onboard RAM.
description is an ASCII character array of up to 32 characters that describes the object.
Using This Function
This function 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 function 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 function.