Camel.lock_dot
Description: Reference for Camel.lock_dot

### Function

# Camellock_dot

#### Declaration [src]

    gint
    camel_lock_dot (
      const gchar* path,
      GError** error
    )

#### Description [src]

Create an exclusive lock using .lock semantics. All locks are equivalent to write locks (exclusive).

The function does nothing and returns success (zero), when dot locking had not been compiled.

#### Parameters

`path`

  Type: `const gchar*`

  A path to lock.

  The data is owned by the caller of the function.
  The value is a NUL terminated UTF-8 string.

`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 function 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: `gint`

-1 on error, sets `ex` appropriately.