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

sapgui_apogrid_get_cell_format

Example APO Grid Functions

Gets the format of the specified APO grid cell.

int sapgui_apogrid_get_cell_format( const char *description, const char *gridID, const char *row, const char *column, const char *outParamName, [args,]  LAST ) ;
description User entered text to aid in understanding script
gridID Object ID string
row Grid row number. The first row is numbered zero (0).
column Grid column identifier. The first column is numbered zero (0).
outParamName The name of the parameter in which to store the data in the cell.
args Optional Arguments
LAST A marker indicating the end of the argument list. Not required if Optional Arguments are used.

sapgui_apogrid_get_cell_format assigns the format description of a cell in an APO grid to parameter outParamName.

Return Values

This function returns -1 on success or 0 on failure.

Parameterization

You can parameterize all string (char type) arguments.