DosFreeModule (OS/2 1.x): Difference between revisions
mNo edit summary |
mNo edit summary |
||
| Line 13: | Line 13: | ||
==Return Code== | ==Return Code== | ||
;rc (USHORT) - return:Return code descriptions are: | |||
Return code descriptions are: | * 0 NO_ERROR | ||
* 0 | * 6 ERROR_INVALID_HANDLE | ||
* 6 | * 12 ERROR_INVALID_ACCESS | ||
* 12 | * 95 ERROR_INTERRUPT | ||
* 95 | |||
==Remarks== | ==Remarks== | ||
| Line 25: | Line 24: | ||
If any exit list routines were registered as a result of this module being loaded, the module may not be freed and ERROR_INVALID_ACCESS may be returned. | If any exit list routines were registered as a result of this module being loaded, the module may not be freed and ERROR_INVALID_ACCESS may be returned. | ||
When DosFreeModule returns to the caller, the module handle is no longer valid and is not used to reference the dynamic link module. Procedure entry addresses returned for this module are no longer valid and cause a protection fault if they are invoked. | When DosFreeModule returns to the caller, the module handle is no longer valid and is not used to reference the dynamic link module. Procedure entry addresses returned for this module are no longer valid and cause a protection fault if they are invoked. | ||
==Example Code== | ==Example Code== | ||
=== C Binding=== | === C Binding=== | ||
| Line 33: | Line 33: | ||
USHORT rc = DosFreeModule(ModuleHandle); | USHORT rc = DosFreeModule(ModuleHandle); | ||
HMODULE | HMODULE ModuleHandle; /* Module handle */ | ||
USHORT | USHORT rc; /* return code */ | ||
</PRE> | </PRE> | ||
This example tries to load module ABCD. The system searches LIBPATH. If unsuccessful, the system tries to load the module from the program's directory (in case the user forgot to update LIBPATH). | This example tries to load module ABCD. The system searches LIBPATH. If unsuccessful, the system tries to load the module from the program's directory (in case the user forgot to update LIBPATH). | ||
| Line 48: | Line 48: | ||
USHORT rc; | USHORT rc; | ||
if (DosLoadModule(LoadError, | if (DosLoadModule(LoadError, /* Object name buffer */ | ||
sizeof(LoadError), | sizeof(LoadError), /* Length of object name buffer */ | ||
MODULE_NAME, /* Module name string */ | |||
MODULE_NAME, | &ModuleHandle) == 2) /* Module handle */ | ||
&ModuleHandle) == 2) | rc = DosLoadModule(LoadError, /* Object name buffer */ | ||
rc = DosLoadModule(LoadError, | sizeof(LoadError), /* Length of object name buffer */ | ||
sizeof(LoadError), | FULL_MODULE_NAME, /* Module name string */ | ||
&ModuleHandle); /* Module handle */ | |||
FULL_MODULE_NAME, | rc = DosFreeModule(ModuleHandle); /* Module handle */ | ||
&ModuleHandle); | </PRE> | ||
rc = DosFreeModule(ModuleHandle); | |||
===MASM Binding=== | ===MASM Binding=== | ||
<PRE> | <PRE> | ||
Revision as of 23:42, 5 April 2019
 Legacy Function Warning
| |
|---|---|
| It is recommended to use a newer replacement for this function. | |
| Replacement: | DosFreeModule |
| Remarks: | Used in OS/2 1.x. |
This call frees the reference to a dynamic link module for a process. When the dynamic link module is no longer needed by any process, the module is freed from system memory.
Syntax
DosFreeModule (ModuleHandle)
Parameters
- ModuleHandle (HMODULE) - input
- Handle returned by DosLoadModule.
Return Code
- rc (USHORT) - return
- Return code descriptions are:
- 0 NO_ERROR
- 6 ERROR_INVALID_HANDLE
- 12 ERROR_INVALID_ACCESS
- 95 ERROR_INTERRUPT
Remarks
The module identified by the handle must be loaded through DosLoadModule. An error is returned if the handle is invalid.
If any exit list routines were registered as a result of this module being loaded, the module may not be freed and ERROR_INVALID_ACCESS may be returned.
When DosFreeModule returns to the caller, the module handle is no longer valid and is not used to reference the dynamic link module. Procedure entry addresses returned for this module are no longer valid and cause a protection fault if they are invoked.
Example Code
C Binding
#define INCL_DOSMODULEMGR USHORT rc = DosFreeModule(ModuleHandle); HMODULE ModuleHandle; /* Module handle */ USHORT rc; /* return code */
This example tries to load module ABCD. The system searches LIBPATH. If unsuccessful, the system tries to load the module from the program's directory (in case the user forgot to update LIBPATH).
#define INCL_DOSMODULEMGR
#define MODULE_NAME "abcd"
#define FULL_MODULE_NAME "\\nifty\\abcd.dll"
CHAR LoadError[100];
HMODULE ModuleHandle;
USHORT rc;
if (DosLoadModule(LoadError, /* Object name buffer */
sizeof(LoadError), /* Length of object name buffer */
MODULE_NAME, /* Module name string */
&ModuleHandle) == 2) /* Module handle */
rc = DosLoadModule(LoadError, /* Object name buffer */
sizeof(LoadError), /* Length of object name buffer */
FULL_MODULE_NAME, /* Module name string */
&ModuleHandle); /* Module handle */
rc = DosFreeModule(ModuleHandle); /* Module handle */
MASM Binding
EXTRN DosFreeModule:FAR INCL_DOSMODULEMGR EQU 1 PUSH WORD ModuleHandle ;Module handle CALL DosFreeModule Returns WORD