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

AME_GETHELPINTRO message

The AME_GETHELPINTRO message is used to get the introductory text of the help message for a plug-in.

Introductory text is limited to 1023 characters, and can include mark-up - see the Remarks section below.

Parameters

guid

Pointer to the GUID of the plug-in whose introductory text 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 introductory text 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 text 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 introductory text is shown under a title of 'Introduction'. We suggest that for this text, you write a brief description of your plug-in and its purpose.

This text can include the following mark-up:

 \paraStarts a new paragraph
 \i1Switches italic on
 \i0Switches italic off
 \u1Switches underline on
 \u0Switches underline off
 \e1Switches bold on
 \e0Switches bold off
 \bulletStart a new bulleted item in a bullet list

Note that the '\' character is the C/C++ escape character, so if you type it into a string in C/C++ code, it will be taken to mean that you're escaping the following character - so when typing in '\para' you should actually enter '\\para', as the escaped '\' character is itself.

Also note that CR or LF characters will not cause new paragraphs in the help message - use \para to do this.

© Copyright 2003-2026 Stoelting Co. All rights reserved

ANY-maze help topic T1012