IExchExtCommands::QueryHelpText

Provides status bar or tool tip Help text for a command.

Quick Info

See IExchExtCommands : IUnknown.

HRESULT QueryHelpText(
  UINT cmdid,      
  ULONG ulFlags,   
  LPTSTR lpsz,     
  UINT cch         
);
 

Parameters

cmdid

[in] Command identifier selected by the user.

ulFlags

[in] Bitmask of flags. The following flags can be set:

EECQHT_STATUS

Microsoft Exchange requests a string to be displayed in the status bar.

EECQHT_TOOLTIP

Microsoft Exchange requests a string to be displayed in a tool tip.

lpsz

[in, out] Buffer to be filled with Help text.

cch

[in] Size of the lpsz parameter's buffer.

Return Values

S_OK

The extension object recognized the cmdid parameter and returned text in the lpsz parameter.

S_FALSE

The extension object did not recognize the cmdid parameter. Microsoft Exchange will continue to call extension objects, and if necessary, provide text itself.

Remarks

Microsoft Exchange calls the IExchExtCommands::QueryHelpText method when the user chooses a menu command or selects and holds the mouse down over a toolbar button. The extension object can provide Help text for any commands it implements or supersede Microsoft Exchange Help text for an existing command.

If an error is returned, Microsoft Exchange will not call other extensions and will use a default or blank string.