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

AME_PERFORMACTION message

The processing of this message is time critical. See Remarks section for details.

The AME_PERFORMACTION message is sent to an Action plug-in to tell it to perform its action.

Parameters

guid

Pointer to the GUID of the plug-in whose action is being invoked. You should check this value to ensure that this message is for your plug-in.

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

wParam

Holds the size of the AME_ACTIONDATA record pointed at by lParam.

lParam

Points at an AME_ACTIONDATA record.

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.

Note that this message will only be sent to plug-ins which return RT_ACTION as their result type, in response to an AME_GETRESULTTYPE message. Therefore there is no need to ever return AME_NOTIMPLEMENTED.

Remarks

This message is sent to a plug-in during a test. For this reason, processing should be performed as quickly as possible. If processing could take more than a few milliseconds, then you should consider creating a separate thread for your plug-in and have the thread perform whatever processing is required. This will ensure that the tracking is not adversely affected by your plug-in.

ANY-maze help topic T1022