Method

AtspiActionget_action_description

Declaration [src]

gchar*
atspi_action_get_action_description (
  AtspiAction* obj,
  int i,
  GError** error
)

Description [src]

Get the description of ‘i-th’ action invocable on an object implementing AtspiAction.

The implementation of this method is provided by atspi_action_get_description() in language bindings.

Parameters

i

Type: int

An integer indicating which action to query.

error

Type: GError **

The return location for a recoverable error.

The argument can be NULL.

If the return location is not NULL, then you must initialize it to a NULL GError*.

The argument will be left initialized to NULL by the method if there are no errors.

In case of error, the argument will be set to a newly allocated GError; the caller will take ownership of the data, and be responsible for freeing it.

Return value

Type: gchar*

A UTF-8 string describing the ‘i-th’ invocable action.

The caller of the method takes ownership of the returned data, and is responsible for freeing it.

The value is a NUL terminated UTF-8 string.