ANY-maze Help > The ANY-maze reference > ANY-maze plug-ins > Plug-in API reference > AME_GETRESULTTYPE message
AME_GETRESULTTYPE message
The AME_GETRESULTTYPE message is used to get the type of result a plug-in provides. This is one of the RT_xxx values (see Remarks section below). If your plug-in does not provide any results, then you should return RT_NONE.
Parameters
guid
Pointer to the GUID of the plug-in whose result type is being requested. 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
Pointer to an unsigned char (i.e. a single byte) which should be set to the result type the plug-in provides. See the Remarks section for possible result types.
Return value
The only valid return codes from this message are:
| • | AME_OK |
| • | AME_ERROR |
If an error occurs, return AME_ERROR, otherwise return AME_OK.
Note that you must return a result TYPE. If your plug-in does not provide any results, then set the result type to RT_NONE and return AME_OK.
Remarks
The result types are:
| RT_NONE | The plug-in does not provide any result. |
| RT_ONOFF | The plug-in provides a binary state result, either on or off. |
| RT_VALUE | The plug-in provides a result which is a specific value at a specific moment in time. |
| RT_CUMULATIVE | The plug-in provides a result which is cumulative, the sum of all the results being the result for the overall test. |
| RT_ACTION | The plug-in doesn't provide a result as such; rather it can perform some type of action. See RT_ACTION for details. |
Example
case AME_GETRESULTTYPE :
//Return the result type in the unsigned char pointed to by lParam
*((unsigned char*)lParam) = RT_ONOFF;
return AME_OK;
© Copyright 2003-2026 Stoelting Co. All rights reserved
ANY-maze help topic T1014