GetMenuBarAttributeLimited
int GetMenuBarAttributeLimited (int panelHandle, int menuOrMenuItemID, int menuBarAttribute, int maximumNumberOfBytes, int *numberOfBytesCopied, unsigned char stringValue[]);
Purpose
This function returns as much of the menu bar attribute value as fits within maximumNumberOfBytes. GetMenuBarAttributeLimited returns values only for attributes with a string data type, such as ATTR_MENU_NAME and ATTR_CONSTANT_NAME.
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. |
| menuOrMenuItemID | int | Specifier for a particular menu bar that is currently in memory. You can obtain
this handle from functions such as LoadMenuBar and NewMenuBar. If the menu bar was automatically loaded through LoadPanel, use GetPanelMenuBar to get the menu bar handle. |
| menuBarAttribute | int | The menu bar attribute value to obtain. You must specify an attribute with a string data type. |
| 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 value of the menu bar attribute 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