ANY-maze Help > The ANY-maze reference > ANY-maze plug-ins > Plug-in API reference > AME_GETHELPTITLE message
AME_GETHELPTITLE message
The AME_GETHELPTITLE message is used to get the title of the help message for a plug-in.
Help titles are limited to 255 characters.
Parameters
guid
Pointer to the GUID of the plug-in whose help title 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
The size of the buffer pointed to by lParam, in bytes.
lParam
Pointer to a character buffer in which the help title should be returned as a NULL-terminated ASCII string.
Return value
The only valid return codes from this message are:
| • | AME_OK |
| • | AME_ERROR |
| • | AME_NOTIMPLEMENTED |
If the code has written a help title to the buffer, then return AME_OK.
If the plug-in does not have a help message, then return AME_NOTIMPLEMENTED.
If an error occurs, return AME_ERROR.
Remarks
Implementing a help message for your plug-in is optional, but highly recommended.
The help title is shown at the top of the help message, and is usually the same as the name of the plug-in.
© Copyright 2003-2026 Stoelting Co. All rights reserved
ANY-maze help topic T1011