DosSubUnsetMem: Difference between revisions
mNo edit summary |
mNo edit summary |
||
| Line 1: | Line 1: | ||
DosSubUnsetMem is used to terminate a memory pool. | |||
=== Syntax === | === Syntax === | ||
rc = DosSubUnsetMem( ''pOffset'' ); | rc = DosSubUnsetMem( ''pOffset'' ); | ||
=== Parameters === | === Parameters === | ||
PVOID ''pOffset'' (input) | ;PVOID ''pOffset'' (input):This is the offset of the memory pool which we no longer need. | ||
This is the offset of the memory pool which we no longer need. | |||
=== Returns === | === Returns === | ||
APIRET rc | APIRET rc | ||
The following values can be returned: | The following values can be returned: | ||
*0 NO_ERROR | |||
*532 ERROR_DOSSUB_CORRUPTED | |||
=== Usage Explanation === | === Usage Explanation === | ||
It is used to allow the suballocation function to release resources it used to manage the suballocation of the memory block. All calls to [[DosSubSetMem]] should be followed by a call to DosSubUnsetMem. All calls to DosSubUnsetMem must occur before the memory block is freed. | |||
function to release resources it used to manage the suballocation of the memory block. All | |||
calls to [[DosSubSetMem]] should be followed by a call to DosSubUnsetMem. All calls to DosSubUnsetMem must occur before the memory block is freed. | |||
=== Sample Code === | === Sample Code === | ||
<pre> | <pre> | ||
#define INCL_DOSMEMMGR | #define INCL_DOSMEMMGR | ||
#include | #include <os2.h> | ||
#include | #include <bsememf.h> | ||
PVOID Offset; /* Offset of the memory pool which we will terminate. */ | PVOID Offset; /* Offset of the memory pool which we will terminate. */ | ||
Latest revision as of 16:19, 9 October 2018
DosSubUnsetMem is used to terminate a memory pool.
Syntax
rc = DosSubUnsetMem( pOffset );
Parameters
- PVOID pOffset (input)
- This is the offset of the memory pool which we no longer need.
Returns
APIRET rc
The following values can be returned:
- 0 NO_ERROR
- 532 ERROR_DOSSUB_CORRUPTED
Usage Explanation
It is used to allow the suballocation function to release resources it used to manage the suballocation of the memory block. All calls to DosSubSetMem should be followed by a call to DosSubUnsetMem. All calls to DosSubUnsetMem must occur before the memory block is freed.
Sample Code
#define INCL_DOSMEMMGR
#include <os2.h>
#include <bsememf.h>
PVOID Offset; /* Offset of the memory pool which we will terminate. */
APIRET rc; /* Just to take care of the return code. */
/* Offset should be set to the offset of the memory pool which we are */
/* about to terminate. */
rc = DosSubUnsetMem( Offset);
if (rc != 0)
{
/* We have an error we must take care of. */
}