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

# fzrt_mem_free

Description

Gets the amount of free memory. This will return the amount of free memory available to the application. This include memory that is in the heap and unused memory in the mem zones. Since this includes all the free memory available to the program, not necessarily contiguous memory, it is unlikely that a allocation request of this size will succeed.

Plugin Prototype

fzrt_error_td fzrt_mem_free(

fzrt_unsigned_int * | mem_free )

Parameters

mem_free [Result]

pointer to fzrt_unsigned_int to receive the amount of free memory

Returns

FZRT_NOERR on success, otherwise an error ID

Availability

5.0.0.0

See Also

, fz_mem_zone_static_init,

Function Set

fz_fzrt_mem_fset

Defined in

fzrt_api.h