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

sapgui_call_method

Example: sapgui_call_method Method and Property Functions

Invokes a method of a SAP object.

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

The sapgui_call_method function identifies the SAP object with the SAP identifier control_id, and calls the object's method method_name. It passes to the method the actual arguments arg1...argn.

In some cases, VuGen generates an additional argument, AdditionalInfo.

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.