en:docs:fapi:dosgetmodhandle

This is an old revision of the document!


This is part of Family API which allow to create dual-os version of program runs under OS/2 and DOS

Note: This is legacy API call. It is recommended to use 32-bit equivalent

2021/09/17 04:47 · prokushev · 0 Comments
2021/08/20 03:18 · prokushev · 0 Comments

This call returns a handle to a previously loaded dynamic link module.

Syntax

DosGetModHandle (ModuleName, ModuleHandle)

Parameters

;ModuleName (PSZ) - input : Address of the ASCIIZ name string containing the dynamic link module name or the pathname string. The filename extension used for dynamic link libraries when a module name is provided is .DLL. When a pathname is provided, the module name may have any extension. ;ModuleHandle (PHMODULE) - output : Address of the handle for the dynamic link module.

Return Code

;rc (USHORT) - return:Return code descriptions are: *0 NO_ERROR *95 ERROR_INTERRUPT *123 ERROR_INVALID_NAME *126 ERROR_MOD_NOT_FOUND

Remarks

If a module name is provided, it must match the name of a module residing in the LIBPATH that is currently loaded. Otherwise an error code is returned. If a pathname is provided, the expanded pathname must match the full pathname of a module that is currently loaded.

The handle returned by this call can be used with DosGetModName. It should not be used with DosGetProcAddr for access to the already loaded dynamic link module. Instead, DosLoadModule should be issued to ensure that the calling process is attached to the module.

Bindings

C

<PRE> #define INCL_DOSMODULEMGR

USHORT rc = DosGetModHandle(ModuleName, ModuleHandle);

PSZ ModuleName; /* Module name string */ PHMODULE ModuleHandle; /* Module handle (returned) */

USHORT rc; /* return code */ </PRE>

MASM

<PRE> EXTRN DosGetModHandle:FAR INCL_DOSMODULEMGR EQU 1

PUSH@ ASCIIZ ModuleName ;Module name string PUSH@ WORD ModuleHandle ;Module handle (returned) CALL DosGetModHandle

Returns WORD </PRE>