[#CheckDiskSpace]
= CheckDiskSpace
:mrdocs:

Check that a directory has enough free space for an additional write.

== Synopsis

Declared in `<util/fs_helpers.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
bool
CheckDiskSpace(
    xref:fs/path.adoc[fs::path] const& dir,
    uint64_t additional_bytes = 0);
----

== Return Value

true if the free space exceeds a safe minimum plus additional_bytes.

== Parameters

[cols="1,4"]
|===
| Name| Description
| *dir* [in]
| The directory whose filesystem is checked.
| *additional_bytes* [in]
| The number of extra bytes expected to be written.
|===


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