Method

PhoshDBusScreenshotcall_screenshot_area_sync

Declaration [src]

gboolean
phosh_dbus_screenshot_call_screenshot_area_sync (
  PhoshDBusScreenshot* proxy,
  gint arg_x,
  gint arg_y,
  gint arg_width,
  gint arg_height,
  gboolean arg_flash,
  const gchar* arg_filename,
  gboolean* out_success,
  gchar** out_filename_used,
  GCancellable* cancellable,
  GError** error
)

Description [src]

Synchronously invokes the ScreenshotArea() D-Bus method on proxy. The calling thread is blocked until a reply is received.

See phosh_dbus_screenshot_call_screenshot_area() for the asynchronous version of this method.

Parameters

arg_x

Type: gint

Argument to pass with the method invocation.

arg_y

Type: gint

Argument to pass with the method invocation.

arg_width

Type: gint

Argument to pass with the method invocation.

arg_height

Type: gint

Argument to pass with the method invocation.

arg_flash

Type: gboolean

Argument to pass with the method invocation.

arg_filename

Type: const gchar*

Argument to pass with the method invocation.

The data is owned by the caller of the method.
The value is a NUL terminated UTF-8 string.
out_success

Type: gboolean*

Return location for return parameter or NULL to ignore.

The argument will be set by the function.
The argument can be NULL.
out_filename_used

Type: gchar**

Return location for return parameter or NULL to ignore.

The argument will be set by the function.
The argument can be NULL.
The caller of the method takes ownership of the data, and is responsible for freeing it.
The value is a NUL terminated UTF-8 string.
cancellable

Type: GCancellable

A GCancellable or NULL.

The argument can be NULL.
The data is owned by the caller of the method.
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: gboolean

TRUE if the call succeeded, FALSE if error is set.