ClipboardGetTableVals
int ClipboardGetTableVals (int panelHandle, int controlID, Rect cellRange, int *available);
Purpose
Determines whether or not text data is available on the system clipboard and/or retrieves a copy of the text and formats it into the specified cell range of a table control.
(Linux) This function accesses only the internal LabWindows/CVI clipboard, not the host system clipboard.
Supported Controls
You can use ClipboardGetTableVals with table controls.
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. |
| cellRange | Rect | The Rect structure that specifies the cell range to which to copy the clipboard data. The Rect structure is defined as follows: typedef struct { int top; int left; int height; int width; } Rect; You can create a Rect without declaring a variable by using the following function: Rect MakeRect (int top, int left, int height, int width); The function assumes that each cell data in the clipboard is separated from the neighboring cell data with a tab character. A line feed instead of a tab character denotes the end of the data for the row. If the number of cells in a given row's data is less than the width of the cell range passed in, the extra cells in that row remain unchanged. If the number is greater than the width, the extra data of that row is ignored.The function interprets the text data for each given cell in accordance with the type of that cell. Cells of type VAL_CELL_NUMERIC remain unchanged unless the text data is convertible into a number matching the data type and format specifications of the cell. Cells of type VAL_CELL_RING remain unchanged unless the clipboard data for the cell matches an existing value in that cell's value list. Cells of type VAL_CELL_PICTURE remain unchanged unless the cell range contains a single cell and there is a bitmap available on the clipboard. |
| Output | ||
| Name | Type | Description |
| available | int | Indicates whether text data is available on the system clipboard. If the specified cell range consists of a single cell, and the type of that cell is VAL_CELL_PICTURE, this parameter instead indicates whether a bitmap image is available on the system clipboard. This parameter is set to 1 if text (or a bitmap) is available on the clipboard. Otherwise, it is set to 0. If you do not need this information, you can pass zero for this parameter. |
Return Value
| Name | Type | Description |
| status | int | Return value indicating whether the function was successful. A negative number indicates that an error occurred. |
Additional Information
Library: User Interface Library
Include file: userint.h
LabWindows/CVI compatibility: LabWindows/CVI 5.5 and later