[#BloombergLP-bdls-FilesystemUtil-getAvailableSpace-0d]
= 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`.

== Synopsis

Declared in `<bdls_filesystemutil.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<class STRING_TYPE>
static
xref:BloombergLP/bdls/FilesystemUtil/Offset.adoc[FilesystemUtil::Offset]
getAvailableSpace(STRING_TYPE const& path);
----

== Description

Same as the overload taking `const char *`.

== Return Value

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

== Parameters

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


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