sapgui_grid_get_columns_count

Grid Functions

Retrieves the number of columns in the grid.

int sapgui_grid_get_columns_count( const char *description, const char *gridID, const char *outParamName, [args,] LAST );
description User entered text to aid in understanding script
gridIDObject ID Strings
outparamName Parameter for the retrieved number of columns in the grid
argsOptional Arguments
LAST A marker indicating the end of the argument list. Not required if Optional Arguments are used.

The sapgui_grid_get_columns_count data retrieval function gets the number of columns in a grid.

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.

Example

This example gets the number of columns in a grid.

char *gridID = "usr/cntlBCALVC_TOOLBAR_D100_C1/shellcont/shell";
sapgui_grid_get_columns_count("Column Count",
        gridID, 
        "paramColCount", LAST );
Example: Output:
Action.c(41): Notify: Saving Parameter "paramColCount = 15"
Action.c(41): Grid - The number of columns is 15