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

AME_APPLYSETTINGS message

The AME_APPLYSETTINGS message is sent to a plug-in whenever the plug-in's settings (if it has any) are altered by the user. This gives the plug-in a chance to update its state based on the new settings. However, in many cases this is unnecessary as the settings are sent to the plug-in as part of the AME_TESTSTART message, and the plug-in may find it easier to process settings at this point.

Parameters

guid

Pointer to the GUID of the plug-in whose settings are to be applied.

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

wParam

The size of the settings buffer pointed to by lParam, in bytes.

lParam

Pointer to a buffer holding the plug-in's settings.

Return value

The only valid return codes from this message are:

•

AME_OK

•

AME_ERROR

•

AME_NOTIMPLEMENTED

If the message is processed successfully, then return AME_OK.

If an error occurs, return AME_ERROR.

If your plug-in does not process this message, you can return AME_NOTIMPLEMENTED.

Remarks

This message is also sent to a plug-in when an ANY-maze experiment is opened, assuming the plug-in is enabled in the experiment.

This message is most useful for processing settings which it is inappropriate to process during AME_TESTSTART. For example, a plug-in which communicates with another program may include a setting for the name of the computer where the other program is running. To open communication across the network with this program may be quite slow (and could even mean a log-on window opens) - performing such processing when a test starts would clearly be a bad idea.

ANY-maze help topic T1016