dadlllink_com
DLL Usage description
This library contains miscellaneous functions used for multi-site exchange control.
There are two groups of functions: functions for handling companies; functions for handling return values of messages; these functions can be used after sending messages for multi-site exchange control (e.g. for activating an exchange link). In the second group these functions are available for each message type X:
lcom.give.message.for.return.value.of.X(long ret)
pre : true
post : Depending on the message type X and the return value ret
this function displays a message for the end user.
The user has to press return to make the message disappear.
string lcom.get.message.for.return.value.of.X(
long ret,
ref bool message.contains.error.code)
pre : true
post : If message.contains.error.code then the message returned
contains a %d which can be filled the error code (ret).
return: Depending on the message type X and the return value ret
this function returns a message code.
desc : The message can be displayed using function mess() or
written to a report or log file using function form.text$().
If message.contains.error.code you can use for example:
- mess(<message code>, 1, ret) or
- log.mess(<message code>, ret) or
- message.string = sprintf$(form.text$(<message code>), ret)
Otherwise you can use:
- mess(<message code>, 1) or
- log.mess(<message code>) or
- message.string = form.text$(<message code>)
Note on the function specifications: "iff" means "if and only if".
DLL Prototypes function extern long lcom.change.company(
domain daxch.comp new.company )
pre : If change.company() has been called before, then
: undo.change.company() must be called first, before calling
: change.company() again.
post : If return then new.company is the current company
: else the current company has not been changed.
return: True iff the current company is now set to new.company.
function extern string lcom.get.message.for.return.value.of.activate(
long ret,
ref long message.contains.error.code )
function extern string lcom.get.message.for.return.value.of.deactivate(
long ret,
ref long message.contains.error.code )
function extern string lcom.get.message.for.return.value.of.destroyed(
long ret,
ref long message.contains.error.code )
function extern string lcom.get.message.for.return.value.of.export.done(
long ret,
ref long message.contains.error.code )
function extern string lcom.get.message.for.return.value.of.import.done(
long ret,
ref long message.contains.error.code )
function extern lcom.give.message.for.return.value.of.activate(
long ret )
function extern lcom.give.message.for.return.value.of.deactivate(
long ret )
function extern lcom.give.message.for.return.value.of.destroyed(
long ret )
function extern lcom.give.message.for.return.value.of.export.done(
long ret )
function extern lcom.give.message.for.return.value.of.import.done(
long ret )
function extern lcom.undo.change.company( )
pre : Function change.company() must have been called before.
post : The current company is the same it was before calling
change.company().