7.2. Dynamic Linking
Dynamic Linking is used to link the DLL at runtime.
Handling Static and Dynamic Linking in the Jedi Environment
Because both static and dynamic linking have their strengths, we must be prepared to support both techniques in the Jedi units. However, static linking is the default.
To support multiple methods compiler symbols are used. The two compiler symbols that symbolize dynamic linking are as follows:
If Xxxx_DYNLINK is defined the DLL must be linked dynamically at startup (in the initialization section).
If Xxxx_LINKONREQUEST is defined the DLL is linked dynamically, not at startup, but as needed by the user. Xxxx is the name of the API, e.g. MAPI_DYNLINK or MAPI_LINKONREQUEST.
If neither symbol is defined, static linking is used.
Each import unit should implement the following functions:
Function XxxxInitAPI: Boolean;
Procedure XxxxFreeAPI;
Function XxxxCheckAPI: Boolean;
The functions XxxxInitAPI and XxxxFreeAPI are available for the user if the symbol Xxxx_LINKONREQUEST is defined. The User can call this function to load or free the DLL. XxxxInitAPI returns TRUE, if the DLL has been loaded successfully.
If Xxxx_DYNLINK is defined, but not Xxxx_LINKONREQUEST, these functions are used internally to load or unload the DLL in the initialization section, but they are not available for the user.
The function XxxxCheckAPI returnes TRUE if the API is available, so the return value is TRUE if the DLL has previously been loaded successfully using XxxxInitAPI. When static linking is used, the return value is always TRUE.
Here is an example of how to handle the symbols in a translation:
unit apisample;
interface
USES Windows,
JediUtil;
// There are two conditional defines. One to use dynamic
// run time linking with linking on startup, the other
// to link upon request. In fact the only difference is
// that the library is not loaded in the initialization
// section if the upon-request symbol is defined.
// Both symbols start with the name of the api, e.g. TAPI.
// In this example it is APISAMPLE.
// APISAMPLE_DYNLINK signals that the API should be linked
// via LoadLibrary and GetProcAddress at startup.
// APISAMPLE_LINKONREQUEST signals that the libary should
// not be linked at startup, but via an initialization procedure.
// Since most of the stuff is the same for both we use
// APISAMPLE_DYNLINK as common symbol.
{$IFDEF APISAMPLE_LINKONREQUEST}
{$DEFINE APISAMPLE_DYNLINK}
{$ENDIF}
{$IFDEF APISAMPLE_DYNLINK}
// Define function types and variables for dynamic linking
TYPE
TApiSampleFunc1 = Function (lParam: LongInt): LongInt; stdcall;
TApiSampleFunc2 = Function (wParam: Word): LongInt; stdcall;
VAR
ApiSampleFunc1 : TApiSampleFunc1 = NIL;
ApiSampleFunc2 : TApiSampleFunc2 = NIL;
{$ELSE}
// We don't use dynamic linking so we implement static linking
Function ApiSampleFunc1 (lParam: LongInt): LongInt; stdcall;
Function ApiSampleFunc2 (wParam: Word): LongInt; stdcall;
{$ENDIF}
//
// Linking Control functions
//
// The XxxxInitAPI function follows <ApiName>InitAPI
// naming convention and is only visible if
// Xxxxx_LINKONREQUEST is defined. The same is true
// for the XxxxxFreeAPI function which frees the
// library
{$IFDEF APISAMPLE_LINKONREQUEST}
Function ApiSampleInitAPI: Boolean;
Procedure ApiSampleFreeAPI;
{$ENDIF}
// The XxxxxCheckAPI function returns true if
// the API is available. With static linking
// the function always returns TRUE
Function ApiSampleCheckAPI: Boolean;
implementation
CONST APISampleDLL = 'APISAMPLE.DLL'; // Name of the DLL
{$IFDEF APISAMPLE_DYNLINK}
VAR hDLL : THandle = 0; // Handle to the lib. Only req. for
dyn.link.
Function ApiSampleInitAPI: Boolean;
begin
Result := FALSE;
// Load library if necessary
If hDLL = 0 then hDLL := LoadLibrary (APISampleDLL);
If JediCheckInstanceHandle (hDLL) then
begin
// Set pointers to functions
@ApiSampleFunc1 := GetProcAddress (hDLL, 'ApiSampleFunc1');
@ApiSampleFunc2 := GetProcAddress (hDLL, 'ApiSampleFunc2');
// Everything ok, return true
Result := TRUE;
end
end;
Procedure ApiSampleFreeAPI;
begin
If hDLL <> 0 then
FreeLibrary (hDLL);
hDLL := 0;
end;
{$ELSE}
Function ApiSampleFunc1; external APISampleDLL name 'ApiSampleFunc1';
Function ApiSampleFunc2; external APISampleDLL name 'ApiSampleFunc1';
{$ENDIF}
Function ApiSampleCheckAPI: Boolean;
begin
{$IFDEF APISAMPLE_DYNLINK}
Result := hDLL <> 0;
{$ELSE}
Result := TRUE;
{$ENDIF}
end;
initialization
begin
{$IFDEF APISAMPLE_DYNLINK}
{$IFNDEF APISAMPLE_LINKONREQUEST}
// Call Init if dynamic linking and not link on request
ApiSampleInitAPI
{$ENDIF}
{$ENDIF}
end;
finalization
begin
{$IFDEF APISAMPLE_DYNLINK}
ApiSampleInitAPI; // Call free if dynamic linking
{$ENDIF}
end;
end.
You can use the the JediCheckInstanceHandle function from the common Jedi-support unit to check an instance handle if necessary.
8. The Jedi Common Support Unit