Share this page
sapgui_get_property_of_active_object
| Example: sapgui_get_property_of_active_object | Method and Property Functions |
Retrieves a property of the active object.
int sapgui_get_property_of_active_object( const char *property_name, const char *output_param_name, [args,] LAST );| property_name | The name of the SAP GUI Object Properties to retrieve |
| output_param_name | The VuGen parameter containing the property of the object |
| args | Optional Arguments |
| LAST | A marker indicating the end of the argument list. Not required if Optional Arguments are used. |
The sapgui_get_property_of_active_object data retrieval function retrieves the value of the specified property property_name from the current active object. The value is saved in output_param_name.
The current object is selected with sapgui_active_object_from_parent_method or sapgui_active_object_from_parent_property.
Note that if the property is a set of strings, output_param_name contains the parameter in the form string1,string2,...,stringn.
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.
