In order for your module to be used within WinGate it needs to export a set of mandatory functions. The WinGate Module Wizard creates these for you if you use it to create your solution/project.
For GUI
...
modules
| Code Block |
|---|
|
extern "C" __declspec(dllexport) int InitialiseGUI(HostAPI* pHost, HostModuleHandle hModule) |
| Vardef |
|---|
| Name | pHost |
|---|
| TypeMod | * |
|---|
| Linked | true |
|---|
| Type | HostApi |
|---|
| Style | Parameter |
|---|
|
Pointer to the UI host API. This is the root interface used to interface to WinGate Management Console. |
| Vardef |
|---|
| Name | hModule |
|---|
| Linked | true |
|---|
| Type | HostModuleHandle |
|---|
| Style | Parameter |
|---|
|
An opaque handle that references this instance of your module. Typically you can ignore this. |
...
See InitialiseGUI
For Engine modules
| Code Block |
|---|
|
extern "C" __declspec(dllexport) int Initialise(HostAPI* pHost, HostModuleHandle hModule, LPCWSTR szRegistryPath) |
| Vardef |
|---|
| Name | pHost |
|---|
| TypeMod | * |
|---|
| Linked | true |
|---|
| Type | HostApi |
|---|
| Style | Parameter |
|---|
|
Pointer to the Engine host API. This is the root interface used to interface to WinGate. |
| Vardef |
|---|
| Name | hModule |
|---|
| Linked | true |
|---|
| Type | HostModuleHandle |
|---|
| Style | Parameter |
|---|
|
An opaque handle that references this instance of your module. Typically you can ignore this. |
| Vardef |
|---|
| Name | szRegistryPath |
|---|
| Type | LPCWSTR |
|---|
| Style | Parameter |
|---|
|
The registry key under HKLM where the module's package information is located. This is the same registry key that holds the manifest file path. |
See Initialise
For all modules
| Code Block |
|---|
|
extern "C" __declspec(dllexport) int ModuleGetAPIVersion() |
ModuleGetAPIVersion should return the version of the API that your module was compiled with. WinGate will check that the version returned from ModuleGetAPIVersion is the same as its own internal version. If they differ, the module will not be loaded.
Typically the function looks like so:
| Code Block |
|---|
|
extern "C" __declspec(dllexport) int ModuleGetAPIVersion()
{
return COMPONENTS_API_VERSION;
} |
