IExchExtCommands::QueryButtonInfo

Provides information about the extension object's toolbar buttons.

Quick Info

See IExchExtCommands : IUnknown.

HRESULT QueryButtonInfo(
  ULONG tbid,        
  UINT itbb,         
  LPTBBUTTON ptbb,   
  LPTSTR lpsz,       
  UINT cch,          
  ULONG ulFlags      
);
 

Parameters

tbid

[in] Toolbar identifier.

itbb

[in] Index into the list of available buttons.

ptbb

[in, out] Pointer to a TBBUTTON toolbar button structure, which can be found in the EXCHEXT.H header file.

lpsz

[in] Pointer to a buffer in which text describing the button should be returned. This description text appears in the Customize Toolbar dialog box. This parameter can be NULL to indicate that text is not required.

cch

[in] Size of the buffer pointed to by the lpsz parameter.

ulFlags

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

EXCHEXT_UNICODE

The lpsz parameter is a unicode string.

Return Values

S_OK

The extension object recognized the itbb parameter and provided information.

S_FALSE

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

Remarks

Microsoft Exchange calls the IExchExtCommands::QueryButtonInfo method when it needs information about a toolbar button. Currently only one toolbar is defined, EETB_STANDARD.

If an error is returned, Microsoft Exchange will not call other extensions and will use default or null information.