IExchangeRuleExt::GetCommand

The GetCommand method retrieves information about a command. The Microsoft Exchange Client calls this method to obtain the command encoding and display name for the command.

HRESULT GetCommand(
  LPEXCHANGERULEEEXTCALLBACK percb,  
  TCHAR FAR * pszCommand,            
  ULONG cchCommand,                  
  TCHAR FAR * pszDisplayName,        
  ULONG cchDisplayName               
);
 

Parameters

percb

Input parameter. Points to an instance of an IExchangeRuleExtCallback interface.

pszCommand

Input/output parameter. Points to a string containing the encoding of the command. This parameter can be initialized with the encoding of a previous command.

cchCommand

Input parameter. The size, in bytes, of the string where pszCommand points.

pszDisplayName

Input/output parameter. Points to a string containing the name of the command that is displayed. This parameter can be initialized with the display name of a previous command.

cchDisplayName

Output parameter. The size, in bytes, of the string where pszDisplayName points.

Return Values

Returns E_FAIL if the user cancels the command; returns NOERROR if the command completes successfully.

See Also

Command, IExchangeRuleExt