Method

IdeCompileCommandsload

Declaration

gboolean
ide_compile_commands_load (
  IdeCompileCommands* self,
  GFile* file,
  GCancellable* cancellable,
  GError** error
)

Description

Synchronously loads the contents of the requested file and parses the JSON command database contained within.

You may only call this function once on an IdeCompileCommands object. If there is a failure, you must create a new IdeCompileCommands instance instead of calling this function again.

See also: ide_compile_commands_load_async()

Parameters

file

Type: GFile

A GFile.

The data is owned by the caller of the method.

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 successful; otherwise FALSE and error is set.