extension_prompt_sync


Description:

public int extension_prompt_sync (string dialog_name, NamedParameters? in_parameters, NamedParameters? out_values, Cancellable? cancellable = null) throws Error

Synchronously prompt a user for a decision on an extension-provided dialog.

The caller usually provides an extension for UserPrompterServer, a descendant of UserPrompterServerExtension, which registers itself as a dialog provider. The extension defines dialog_name, same as meaning of in_parameters; only the extension and the caller know about meaning of these.

Caller can provide out_values to get additional values provided by the extension. In case the caller is not interested in additional values, it can pass null out_values. The out_values will be cleared first, then any values will be added there. Only the caller and the extension know about meaning of the result code and additional values.

If an error occurred, the function sets throws and returns -1. If there is no extension providing given dialog name, the operation finishes with a G_IO_ERROR, G_IO_ERROR_NOT_FOUND throws.

Parameters:

this

an UserPrompter

dialog_name

name of a dialog to invoke

in_parameters

optional parameters to pass to extension; can be null

out_values

Where to store values from the extension, or null

cancellable

optional Cancellable object, or null

Returns:

Result code of the prompt, as defined by the extension, or -1 on error.