sapgui_is_object_changeable

Verification and Data Retrieval Functions

Checks if an object is enabled and writable.

int sapgui_is_object_changeable( const char *controlID, [args,] LAST );
controlIDObject ID Strings
argsOptional Arguments
LAST A marker indicating the end of the argument list. Not required if Optional Arguments are used.

The sapgui_is_object_changeable verification function returns whether a component can be modified. A component can be modified if it is neither disabled nor read-only.

Return Values

This function returns True (-1) or False (0).

Parameterization

You can parameterize all string (char type) arguments.

Example

The following example uses sapgui_is_object_changeable to check if a tree control can be modified.

sapgui_tree_select_item("SAP Column Tree, REPTITLE", 
    "shellcont/shell", // Component ID
    "000712", 
    "REPTITLE", LAST );  
// Check if tree can be modified
// Output = "Tree is changeable"
if (sapgui_is_object_changeable("shellcont/shell", LAST))
    lr_output_message("Tree is changeable");
    else
    lr_output_message("Tree is not changeable");