flex_read_description_rtn |
Read Memory Object Description
Usage
status = flex_read_description_rtn(u8 boardID, u8 object, i8* description);
Purpose
Reads the 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 or ROM.
description is an ASCII character array of up to 32 characters that describes the object.
Using This Function
This function returns the ASCII text description for a program or buffer object. The ASCII text description, previously loaded with the Load Memory Object Description function, is useful as a quick reminder of the contents or purpose of an object stored in memory.