SAP GUI Functions (SAPGUI) > Alphabetical List of Functions > sapgui_grid_set_column_order

sapgui_grid_set_column_order

Example: sapgui_grid_set_column_order Grid Functions

Sets the order of grid columns.

int sapgui_grid_set_column_order( const char *description, const char *gridID, const char *row, const char *columns, [args,] LAST );
description User entered text to aid in understanding script
gridID Object ID Strings
columns A comma separated list of Grid column identifiers. The list must be terminated with either an optional arguments clause or with LAST. Grid column identifier: The column identifier string is inserted in the script during recording. This string is the field name defined in the SAP data dictionary. This identifier cannot be replaced with a column number.
args Optional Arguments
LAST A marker indicating the end of the argument list. Not required if Optional Arguments are used.

sapgui_grid_set_column_order emulates a user dragging a column to a new position in the grid.

The "columns" list must contain each column ID in the grid exactly once.

Return Values

This function returns LR_PASS (0) on success or LR_FAIL (1) on failure.

Parameterization

You can parameterize all string (char type) arguments.