IExchExtCommands::Help

Provides user Help for a command.

Quick Info

See IExchExtCommands : IUnknown.

HRESULT Help(
  LPEXCHEXTCALLBACK lpeecb,   
  UINT cmdid                  
);
 

Parameters

lpeecb

[in] Pointer to an IExchExtCallback interface.

cmdid

[in] Command identifier selected by the user.

Return Values

S_OK

The extension object recognized the cmdid parameter and provided Help. Microsoft Exchange will consider the task handled.

S_FALSE

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

Remarks

Microsoft Exchange calls the IExchExtCommands::Help method when the user requests Help on a command. If the extension object has added a menu, the cmdid parameter corresponding to that menu is the cmdid parameter of the first command on the menu minus one.

The extension object can provide Help for any command it implements or supersede Microsoft Exchange Help text for an existing command.