/*
- * $Id$
+ * fontconfig/doc/fcatomic.fncs
*
* Copyright © 2003 Keith Packard
*
@TYPE1@ FcAtomic * @ARG1@ atomic
@PURPOSE@ lock a file
@DESC@
-Attempts to lock the file referenced by <parameter>atomic</parameter>. Returns FcFalse if the
-file is locked by another process, else returns FcTrue and leaves the file
-locked.
+Attempts to lock the file referenced by <parameter>atomic</parameter>.
+Returns FcFalse if the file is already locked, else returns FcTrue and
+leaves the file locked.
@@
@RET@ FcChar8 *
@TYPE1@ FcAtomic * @ARG1@ atomic
@PURPOSE@ replace original with new
@DESC@
-Replaces the original file referenced by <parameter>atomic</parameter> with the new file.
+Replaces the original file referenced by <parameter>atomic</parameter> with
+the new file. Returns FcFalse if the file cannot be replaced due to
+permission issues in the filesystem. Otherwise returns FcTrue.
@@
@RET@ void