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

AME_TESTABORT message

The AME_TESTABORT message is sent to each active plug-in when a test is aborted - usually by the user ending the test and choosing not to save the test results.

Parameters

guid

Pointer to the GUID of the plug-in which is being notified of the test end. 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

Not used; always 0.

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, return AME_ERROR.

Remarks

A plug-in should use this message to free any resources it is using, and to delete its context record (assuming it allocated one). Note that all results of the test will be deleted (because the test is being aborted), so (unlike AME_TESTEND processing) there is no need to return AME_CANCELLED if your plug-in encountered some type of error during the test.

ANY-maze help topic T1021