[#FlatFileSeq-Allocate]
= xref:FlatFileSeq.adoc[FlatFileSeq]::Allocate
:relfileprefix: ../
:mrdocs:

Allocate additional space in a file after the given starting position. The amount allocated will be the minimum multiple of the sequence chunk size greater than add_size.

== Synopsis

Declared in `<flatfile.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
size_t
Allocate(
    xref:FlatFilePos.adoc[FlatFilePos] const& pos,
    size_t add_size,
    bool& out_of_space) const;
----

== Return Value

The number of bytes successfully allocated.

== Parameters

[cols="1,4"]
|===
| Name| Description
| *pos* [in]
| The starting position that bytes will be allocated after.
| *add_size* [in]
| The minimum number of bytes to be allocated.
| *out_of_space* [out]
| Whether the allocation failed due to insufficient disk space.
|===


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