freeMemory method

Description

Returns the memory size that can be used by Explicit memory blocks.

Format

public long freeMemory();

Parameters

None

Exceptions

InaccessibleMemoryAreaException:
This functionality is not supported.

Return value

The common error check is performed and then this method returns either of the following values. For details on common error check, see 10.6 Error check (common error check) of the process that controls the Explicit memory block.

0:
Returned when the API processing cannot be performed.
The memory size (number of bytes) that can be used for the Explicit memory block indicated by this object:
When you can perform API processing, the memory size that can be used for the Explicit memory block, indicated by the object, is returned in the long type.