formZ SDK | 5.0 API Reference | System | Runtime Library (FZRT) | Memory

# fzrt_max_mem

Description

Gets the maximum available memory. This will return the size, in bytes, of the largest contiguous free block in the application heap after purging and compacting. Under virtual memory systems, this is just an estimate. The grow parameter is the amount by which the heap can grow.

Plugin Prototype

fzrt_error_td fzrt_max_mem(

fzrt_size * | grow,
fzrt_size * | size )

Parameters

grow [Result]

The maximum number of bytes by which the current heap zone can grow.

size [Result]

The size, in bytes, of the largest contiguous free block in the heap after purging and compacting

Returns

The size, in bytes, of the largest contiguous free block in the heap after purging and compacting.

Availability

5.0.0.0

Function Set

fz_fzrt_mem_fset

Defined in

fzrt_api.h