[#util-LockResult]
= xref:util.adoc[util]::LockResult
:relfileprefix: ../
:mrdocs:

Outcome of trying to acquire a directory lock.

== Synopsis

Declared in `<util/fs_helpers.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
enum class LockResult : int;
----

== Members

[cols="1,4"]
|===
| Name| Description
| `Success` 
| The directory lock was acquired.
| `ErrorWrite` 
| The lock file could not be created or written.
| `ErrorLock` 
| The directory is already locked by another process.
|===


== Non-Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:util/LockDirectory.adoc[`LockDirectory`]
| Acquire an exclusive lock on a directory via a lock file.
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#