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

sapgui_tree_set_column_order

Example: sapgui_tree_set_column_order Tree Functions

Sets order of columns in a tree.

int sapgui_tree_set_column_order( const char *description, const char *treeID, const char *columns, [args,] LAST ) ;
description User entered text to aid in understanding script
treeID Object ID Strings
columns A comma separated list of Column identifiers. The list must be terminated either with an optional arguments clause or with LAST. 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_tree_set_column_order sets the order of columns in a tree. The new order is the determined by the position of the column in the columns list.

The columns list must contain each column ID in the tree 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.