The purpose of this module is just to document the procedures added by the addLoadProc() template.

This module must not be imported!

Imports

types

Procs

proc mBeta(): int {.inline, ...raises: [], tags: [].}: Returns the beta version of mIRC. Returns -1 if unable to determine and 0 if it is not a beta version. Source Edit
proc mKeepLoaded(): bool {.inline, ...raises: [], tags: [].}: Returns true if mIRC will keep the dll loaded after the call. If it returns false mIRC will unload the dll after the call. Source Edit
proc mMainWindowHandle(): HWND {.inline, ...raises: [], tags: [].}: Returns a HWND for the identifier of the main window of mIRC. The HWND type is an alias for int. Source Edit
proc mMajor(): int {.inline, ...raises: [], tags: [].}: Returns the fixed major version of mIRC. Returns -1 if unable to determine. Source Edit
proc mMaxBytes(): int {.inline, ...raises: [], tags: [].}: Returns the size, in bytes, allocated in the pointers to the data and parms parameters. Source Edit
proc mMinor(): int {.inline, ...raises: [], tags: [].}: Returns the fixed minor version of mIRC. Returns -1 if unable to determine. Source Edit
proc mRawVersion(): uint32 {.inline, ...raises: [], tags: [].}: Returns a uint32 with the raw version passed by mIRC, in the mVersion field, of the LoadInfo object, when loading the dll.

It is recommended to use the mMajor() and mMinor().
Source Edit
proc mToCStringAndCopy(dest: pointer | cstring; source: string) {.inline.}: Transforms source to cstring and copies it to dest up to the byte limit of mMaxBytes(). Source Edit
proc mToWideCStringAndCopy(dest: pointer | WideCString; source: string): Transforms source into WideCString and copies it to dest up to the byte limit of mMaxBytes(). Source Edit
proc mUnicode(): bool {.inline, ...raises: [], tags: [].}: Returns true if the communication between mIRC and the dll will be via unicode strings (WideCString). If it returns false the communication will be by ANSI C strings. Source Edit

src/mdlldk/onlydocumentation

Imports

Procs