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

AME_TESTEND message

The AME_TESTEND message is sent to each active plug-in when a test ends successfully. See AME_TESTABORT for the message sent when a test is aborted.

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

•

AME_CANCELLED

If the message is processed successfully, then return AME_OK.

If your plug-in detected some type of error during the test, and wants any results recorded for it to be deleted, return AME_CANCELLED. Note that this will only cause the results of this plug-in to be deleted. Other test results, including any from other plug-ins, will be retained.

If an error occurs, return AME_ERROR. In this case, ANY-maze will not delete any results recorded for the plug-in during the test.

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).

ANY-maze help topic T1020