Shell.PerfLog.dump_events

### Method

# Shell PerfLogdump_events

#### Declaration [src]

    gboolean
    shell_perf_log_dump_events (
      ShellPerfLog* perf_log,
      GOutputStream* out,
      GError** error
    )

#### Description [src]

Dump the definition of currently defined events and statistics, formatted as JSON, to the specified output stream. The JSON output is an array, with each element being a dictionary of the form:

{ name: , description: <description of string, statistic: true } (only for statistics).

#### Parameters

`out`

  Type: `GOutputStream`

  Output stream into which to write the event definitions.

  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 dump succeeded. `FALSE` if an IO error occurred.