Internally defined structures

DEFRECORD definitions

$DECLARE definitions

For generic buffer types see generic buffer types

$DECLARE definitions

$DECLARE 'KCMLObjectExport(ObjectType$, interface$, wsdl$, endpoint$)

Defines the interface for a COM or SOAP server

This defines the interface for a COM or SOAP server. For COM server calls the last two arguments should be zero or blank.

Returns: a boolean, TRUE for success, FALSE for bad arguments

// $DECLARE 'KCMLObjectExport(ObjectType$, interface$, wsdl$, endpoint$)
// Defines the interface for a COM or SOAP server
$DECLARE 'KCMLObjectExport(STR(), STR(), STR(), STR()) = "*"

This executes on the server.

$DECLARE 'KCMLObjectGetLastError(ObjectType$, nError)

Returns the last object error

// $DECLARE 'KCMLObjectGetLastError(ObjectType$, nError)
// Returns the last object error
$DECLARE 'KCMLObjectGetLastError(STR(), RETURN INT()) = "*"

This executes on the server.

$DECLARE 'KCMLObjectGetLastErrorString(ObjectType$, sError$)

Returns the last object error string

// $DECLARE 'KCMLObjectGetLastErrorString(ObjectType$, sError$)
// Returns the last object error string
$DECLARE 'KCMLObjectGetLastErrorString(STR(), RETURN STR()) = "*"

This executes on the server.

$DECLARE 'KCMLObjectGetErrorString(ObjectType$, nError, sError$)

Returns the object error string given the object error

// $DECLARE 'KCMLObjectGetErrorString(ObjectType$, nError, sError$)
// Returns the object error string given the object error
$DECLARE 'KCMLObjectGetErrorString(STR(), INT(), RETURN STR()) = "*"

This executes on the server.

$DECLARE 'KCMLObjectGetUsername(ObjectType$, user$, bCheckUser)

Returns the user authorization details for a SOAP request

// $DECLARE 'KCMLObjectGetUsername(ObjectType$, user$, bCheckUser)
// Returns the user authorization details for a SOAP request
$DECLARE 'KCMLObjectGetUsername(STR(), RETURN STR(), INT()) = "*"

This executes on the server.

$DECLARE 'KCMLStringMD5(buffer$, hash$)

Returns an MD5 hash for a buffer. Now obsolete and replaced by 'KCML_MD5(text$, BYREF digest$)

Uses Rivest's MD5 algorithm (see RFC1321) to generate a 128 bit hash of a document. It is mathematically very unlikely that two different strings will generate the same message digest. This is very much more secure than a traditional CRC checksum but computationally more expensive to derive.

Returns: a boolean, TRUE for success, FALSE for bad arguments

// $DECLARE 'KCMLStringMD5(buffer$, hash$)
// Returns an MD5 hash for a buffer. Now obsolete and replaced by 'KCML_MD5(text$, BYREF digest$)
$DECLARE 'KCMLStringMD5(STR(), RETURN DIM()) = "*"

This executes on the server.

$DECLARE 'KCMLStartExecTimer()

Start an execution timer

Starts a millisecond timer that counts the time spent executing code. The timer is suspended when waiting for mouse/keyboard input and when executing $BREAK and $IF statements.

Returns: Returns the ID of the new timer, zero for failure.

// $DECLARE 'KCMLStartExecTimer()
// Start an execution timer
$DECLARE 'KCMLStartExecTimer() = "*"

This executes on the server.

$DECLARE 'KCMLStopExecTimer(timerId, pollTimer, tExec$)

Returns the execution time.

Returns the number of milliseconds of execution time, in $TIMESTAMP format, since the timer was started with 'KCMLStartExecTimer(). Time spent waiting on input is not counted. If pollTimer is FALSE the timer is stopped and the timer's ID is no longer valid.

Returns: a boolean, TRUE for success, FALSE for bad argumentents, or if the timer ID is not valid.

// $DECLARE 'KCMLStopExecTimer(timerId, pollTimer, tExec$)
// Returns the execution time.
$DECLARE 'KCMLStopExecTimer(INT(), INT(), RETURN DIM()) = "*"

This executes on the server.