Method

interpeerWyrdApiopen_file

deprecated: 0.1.0 since: 0.1.0

Declaration

WyrdHandle*
interpeer_wyrd_api_open_file (
  WyrdApi* self,
  const char* filename,
  WyrdOpenFlags flags,
  GError** error
)

Description

Opens an otherwise unstructured file for storing/retrieving wyrd properties.

Note

This function should not be used, and is marked deprecated as a result. It exists mostly for testing purposes. Use interpeer_wyrd_api_open_resource() instead.

Stability: Stable

Available since: 0.1.0

Deprecated since: 0.1.0

Use interpeer_wyrd_api_open_resource() instead.

Parameters

filename

Type: const char*

The (UTF-8 encoded) name of the file to open.

The data is owned by the caller of the method.

The value is a NUL terminated UTF-8 string.

flags

Type: WyrdOpenFlags

Flags specifying how to open the file (see WyrdOpenFlags)

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: WyrdHandle

No description available.

The caller of the method takes ownership of the data, and is responsible for freeing it.