DosMemAvail: Difference between revisions
Appearance
No edit summary |
mNo edit summary |
||
Line 1: | Line 1: | ||
This call returns the size of the largest block of free memory. | This call returns the size of the largest block of free memory. | ||
==Syntax== | ==Syntax== | ||
DosMemAvail (MemAvailSize) | |||
DosMemAvail | |||
==Parameters== | ==Parameters== | ||
; MemAvailSize (PULONG) - output : Address of the size of the largest free block of memory. | ;MemAvailSize (PULONG) - output : Address of the size of the largest free block of memory. | ||
==Return Code== | ==Return Code== | ||
rc (USHORT) - return | rc (USHORT) - return | ||
Return code description is: | Return code description is: | ||
*0 NO_ERROR | *0 NO_ERROR | ||
Line 48: | Line 39: | ||
Returns WORD | Returns WORD | ||
</PRE> | </PRE> | ||
==Related Functions== | ==Related Functions== | ||
* | *[[DosAllocHuge]] | ||
[[Category: | [[Category:Dos]] |
Revision as of 08:24, 13 February 2017
This call returns the size of the largest block of free memory.
Syntax
DosMemAvail (MemAvailSize)
Parameters
- MemAvailSize (PULONG) - output
- Address of the size of the largest free block of memory.
Return Code
rc (USHORT) - return
Return code description is:
- 0 NO_ERROR
Remarks
DosMemAvail allows an application to determine how heavily used system memory is at a particular time. The returned value is a "snapshot" that may be valid only at the moment this function is issued and can be expected to change at any time due to system activity.
This call can be used as an indicator for memory availability before a call to DosAllocHuge is made.
Example Code
C Binding
#define INCL_DOSMEMMGR USHORT rc = DosMemAvail(MemAvailSize); PULONG MemAvailSize; /* Size available (returned) */ USHORT rc; /* return code */
MASM Binding
EXTRN DosMemAvail:FAR INCL_DOSMEMMGR EQU 1 PUSH@ DWORD MemAvailSize ;Size available (returned) CALL DosMemAvail Returns WORD