GetLabelFromIndexLimited
int GetLabelFromIndexLimited (int panelHandle, int controlID, int itemIndex, int maximumNumberOfBytes, int *numberOfBytesCopied, unsigned char itemLabel[]);
Purpose
This function returns as much of the label for a specific list item as fits within maximumNumberOfBytes.
Parameters
| Input | ||
| Name | Type | Description |
| panelHandle | int | Specifier for a particular panel that is currently in memory. You can obtain this handle from functions such as LoadPanel and NewPanel. |
| controlID | int | The defined constant, located in the .uir header file, that you assigned to the control in the User Interface Editor, or the ID returned by functions such as NewCtrl and DuplicateCtrl. |
| itemIndex | int | Zero-based index of the item in the list that contains label you want to obtain. |
| maximumNumberOfBytes | int | The maximum number of bytes to obtain from the string value, including the ASCII NUL byte. |
| Output | ||
| Name | Type | Description |
| numberOfBytesCopied | int | Returns the number of bytes successfully obtained, including the ASCII NUL byte. |
| itemLabel | unsigned char [] | Returns the value of the item label that fits within maximumNumberOfBytes. |
Return Value
| Name | Type | Description |
| status | int | Returns 0 if the function succeeded or a negative error code if the function failed. You can obtain a description of any of these error codes using the GetGeneralErrorString function in the toolbox.fp instrument driver. |
Additional Information
Library: Programmer's Toolbox
Include file: toolbox\toolbox.h
LabWindows/CVI compatibility: LabWindows/CVI 2012 and later