ANY-maze Help > The ANY-maze reference > ANY-maze plug-ins > Plug-in API reference > AME_TESTPAUSE message

AME_TESTPAUSE message

The AME_TESTPAUSE message is sent to each active plug-in when a test is paused or unpaused.

Parameters

guid

Pointer to the GUID of the plug-in which is being notified of the pause. All plug-ins that the user has activated (in the protocol) will be sent this message (except for any plug-in which returned AME_ERROR from its AME_TESTSTART processing.)

If a DLL only implements a single plug-in, it can ignore this parameter - although it is good practice to always check it.

wParam

TRUE if the test has been paused, FALSE if the test has been unpaused.

lParam

The 'Context' value returned in the AME_TESTDATA Context field by the AME_TESTSTART processing.

Return value

The only valid return codes from this message are:

•

AME_OK

•

AME_ERROR

If the message is processed successfully, then return AME_OK.

If an error occurs, you should return AME_ERROR. However, this won't have any effect on the testing, and ANY-maze will continue to send messages to your plug-in as the test proceeds.

Remarks

Most plug-ins can ignore this message. It is mainly useful for plug-ins which communicate with some other program, as it allows them to notify the other program that the test has been paused.

ANY-maze help topic T1019