Platform SDK: Exchange Server

IExchangeRuleExt::QueryCommandDisplayName

The QueryCommandDisplayName method retrieves the display name of a command. The Inbox Assistant calls this method when the user edits an existing rule that specifies a custom action.

HRESULT QueryCommandDisplayName(
  LPEXCHANGERULEEXTCALLBACK percb,  
  LPCTSTR pszCommand,               
  TCHAR FAR * pszDisplayName,       
  ULONG cchDisplayName              
);
 

Parameters

percb
Input parameter. Points to an instance of an IExchangeRuleExtCallback interface.
pszCommand
Input parameter. Points to a string containing the encoding of the command.
pszDisplayName
Output parameter. Points to a string containing the name of the command that is displayed.
cchDisplayName
Output parameter. The size, in bytes, of the string where pszDisplayName points.

Return Values

Return E_FAIL if the user cancels the command; return NOERROR if the command completes successfully.

Remarks

The display name should be the same as the name originally returned by the GetCommand method. Microsoft Exchange Server does not save that display name when it saves the Inbox Assistant rule.

See Also

IExchangeRuleExt