[#BloombergLP-bdls-FilesystemUtil-getAvailableSpace-0a]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdls.adoc[bdls]::xref:BloombergLP/bdls/FilesystemUtil.adoc[FilesystemUtil]::getAvailableSpace
:relfileprefix: ../../../
:mrdocs:

Return the number of bytes available on the file system of `path`&period;

== Synopsis

Declared in `&lt;bdls&lowbar;filesystemutil&period;h&gt;`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
static
xref:BloombergLP/bdls/FilesystemUtil/Offset.adoc[Offset]
getAvailableSpace(char const* path);
----

== Description

Return the number of bytes available for allocation in the file system where the file or directory with the specified `path` resides, or a negative value if an error occurs&period; The parameterized `STRING&lowbar;TYPE` must be one of `bsl&colon;&colon;string`, `std&colon;&colon;string`, `std&colon;&colon;pmr&colon;&colon;string` (if supported), `bsl&colon;&colon;string&lowbar;view`, or `bslstl&colon;&colon;StringRef`&period;

== Return Value

the number of available bytes, or a negative value on error

== Parameters

[cols="1,4"]
|===
| Name| Description
| *path*
| filesystem path whose volume&apos;s free space is returned
|===


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