[#fsbridge-FileLock]
= xref:fsbridge.adoc[fsbridge]::FileLock
:relfileprefix: ../
:mrdocs:

Advisory lock on a file, released when the object is destroyed.

== Synopsis

Declared in `<util/fs.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
class FileLock;
----

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:fsbridge/FileLock/2constructor-0a.adoc[`FileLock`]         [.small]#[constructor]#
| Constructors
| xref:fsbridge/FileLock/2destructor.adoc[`~FileLock`] [.small]#[destructor]#
| Release the lock, if held, and close the underlying file handle.
| xref:fsbridge/FileLock/GetReason.adoc[`GetReason`] 
| Describe why the most recent TryLock() failed.
| xref:fsbridge/FileLock/TryLock.adoc[`TryLock`] 
| Attempt to acquire the lock without blocking.
|===



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