[#CheckDiskSpace]
= CheckDiskSpace
:mrdocs:

Check that a directory has enough free space for an additional write&period;

== Synopsis

Declared in `&lt;util&sol;fs&lowbar;helpers&period;h&gt;`

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

== Return Value

true if the free space exceeds a safe minimum plus additional&lowbar;bytes&period;

== Parameters

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


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