GetCtrlValLimited
int GetCtrlValLimited (int panelHandle, int controlID, int maximumNumberOfBytes, int *numberOfBytesCopied, unsigned char stringValue[]);
Purpose
This function returns as much of the string value as fits within maximumNumberOfBytes. You can obtain string values from the following controls:
- Strings
- Text messages
- Text boxes
- Rings (data type must be set to string)
- Ring slides (data type must be set to string)
- Picture rings (data type must be set to string)
- Binary switches (data type must be set to string)
- Trees (data type must be set to string)
- List boxes (data type must be set to string)
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. |
| 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. |
| stringValue | unsigned char [] | Returns the string value 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