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

== Synopsis

Declared in `<bdls_filesystemutil.h>`

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

== Description

Return the number of bytes available for allocation in the file system where the file with the specified `descriptor` resides, or a negative value if an error occurs.

== Return Value

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

== Parameters

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


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