Ping Function

Tests for XCALL subroutine availability.

Syntax

IXcall.Ping(XcallBlock)

Parameters

XcallBlock

An ASHW32Lib.IXcallBlock interface to a dummy A-Shell XCALL parameter block.

Return Value

A Boolean value indicating whether the XCALL subroutine is OK to execute.

Remarks

The Ping function is called the first time the XCALL subroutine is called. If True is returned, then the Execute method will be called. If False is returned, then an ‘XCALL subroutine not found’ error will be returned for this and all subsequent XCALL calls to this routine within the A-Shell session.

The Ping function should be used to check any necessary dependencies or licensing issues. Because of the extensibility of the A-Shell interfaces, the Ping function should also check the A-Shell version to ensure that all required functions, properties, and methods are implemented. The A-Shell version can be determined with the Version property of the IApplication interface, for example with the following Visual BASIC expression:

XcallBlock.Application.Version(jbvtVerString)