Method

PhoshDBusSessionManagercall_inhibit_sync

Declaration [src]

gboolean
phosh_dbus_session_manager_call_inhibit_sync (
  PhoshDBusSessionManager* proxy,
  const gchar* arg_app_id,
  guint arg_toplevel_xid,
  const gchar* arg_reason,
  guint arg_flags,
  guint* out_inhibit_cookie,
  GCancellable* cancellable,
  GError** error
)

Description [src]

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

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

Parameters

arg_app_id

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.
arg_toplevel_xid

Type: guint

Argument to pass with the method invocation.

arg_reason

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.
arg_flags

Type: guint

Argument to pass with the method invocation.

out_inhibit_cookie

Type: guint*

Return location for return parameter or NULL to ignore.

The argument will be set by the function.
The argument can be NULL.
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.