Custom Item Symbols:Get Symbol Method
Short Name: Custom Item Symbols.Get Symbol
Installed With: Full Development System
Class: TreeControl Methods
Returns the item symbol as a cluster of image data so you can draw it as a picture using the Draw Flattened Pixmap VI or save the image to a file using the Graphics Formats VIs.
The cluster returned by this method is similar to the image data output of the Read JPEG File, Read PNG File, and Read BMP File VIs.
Parameters
| Name | Required | Description |
|---|---|---|
| index | No | The index of the symbol whose image data you want to obtain. |
| output | No | Describes the item symbol image(s). |
Remarks
The following table lists the characteristics of this method.
| Available in Run-Time Engine and Real-Time Operating System | Yes (Read/Write) |
| Settable when the VI is running | Yes |
| Loads the front panel into memory | No |
| Need to authenticate before use | No |
| Loads the block diagram into memory | No |
| Remote access disallowed | No |
| Must wait until user interface is idle | No |
| Available with control VIs | No |
| Available with global VIs | No |
| Available with strict type definitions | No |
| Available with polymorphic VIs | No |