ClipboardPutTableVals

int ClipboardPutTableVals (int panelHandle, int controlID, Rect cellRange);

Purpose

Copies the data from the specified cell range of a table control onto the clipboard.

Linux This function affects only the internal LabWindows/CVI clipboard, not the host system clipboard.

Parameters

Input
Name Type Description
panelHandle integer Specifier for a particular panel that is currently in memory. You obtain this handle from LoadPanel, NewPanel, or DuplicatePanel.
controlID integer 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 NewCtrl or DuplicateCtrl.
cellRange rect The Rect structure that specifies the cell range from 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 having to declare a variable by using the following function:

Rect MakeRect (int top, int left, int height, int width);

The function places each cell data in the clipboard separated from the neighboring cell data with a tab character. For the last cell in each row, it places a line feed after its data.

The function treats cells of type VAL_CELL_PICTURE as cells of type VAL_CELL_STRING containing empty strings. Only the separator tab, or line feed, is copied for such cells. However, if the cell range consists of a single cell, and its type is VAL_CELL_PICTURE, the function copies the corresponding bitmap onto the clipboard. In that case, no text is copied onto the clipboard.

Return Value

Name Type Description
status integer Return value indicating whether the function was successful. A negative number indicates that an error occurred.

Code Error Message String
xx Success