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

sapgui_active_object_from_parent_method

Example: sapgui_active_object_from_parent_method Method and Property Functions

Selects an object within a parent object by calling the parent's method.

int sapgui_active_object_from_parent_method( const char *control_id, const char *method_name, char *arg1, ..., char *argn, [optionArguments,] LAST );
control_id Object ID Strings
method_name The name of the SAP method to invoke
args Arguments to the method
optionArguments Optional Arguments
LAST A marker indicating the end of the argument list. Not required if Optional Arguments are used.

The function sapgui_active_object_from_parent_method selects an object from within a larger parent object with an identification number control_id. The embedded object is returned by the method method_name.

For example, a row of a table has no specific control ID. However, you can access the row by passing both the ID of the table control (as control_id) and the SAP method (method_name) which returns a row within a table.

args are the arguments that are passed to the control's method.

After sapgui_active_object_from_parent_method, the object becomes the active object. Invocations of sapgui_call_method_of_active_object, sapgui_set_property_of_active_object, or sapgui_get_property_of_active_object will apply to that object.

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.