HrInstallMailboxAgent

The HrInstallMailboxAgent function loads a mailbox agent object into a site.

Quick Info

Header file: EXCHINST.H
Library: EXCHINST.LIB 

HRESULT HrInstallMailboxAgent(
  LPSTR lpszServer,      
  LPSTR lpszSiteDN,      
  LPSTR lpszDisplayName, 
  LPSTR lpszRDN,         
  LPSTR lpszExtensionName,  
  LPSTR lpszExtensionData,  
  LPSTR lpszAccountName  
);

Parameters

lpszServer
Input parameter. Points to a null-terminated string (with a maximum length of 256 characters) that contains the name of the server where the mailbox agent is installed.
lpszSiteDN
Input parameter. Points to a null-terminated string (with a maximum length of 256 characters) that contains the distinguished name (DN) of the site where the mailbox agent is installed.
lpszDisplayName
Input parameter. Points to a null-terminated string (with a maximum length of 256 characters) that contains the name of the mailbox agent as displayed by the Microsoft Exchange Server Administrator program.

Although the Windows NT service control manager preserves the case of the name that is displayed, comparisons between display names are case-insensitive.

lpszRDN
Input parameter. Points to a null-terminated string (with a maximum length of 256 characters) that contains the relative distinguished name (RDN) of this mailbox agent.
lpszExtensionName
Input parameter. Points to a null-terminated string (with a maximum length of 256 characters) that contains the name of the Administrator extension program that supports this mailbox agent.
lpszExtensionData
Input parameter. Points to a null-terminated string (with a maximum length of 256 characters) that contains the name of the extension data file.
lpszAccountName
Input parameter. Points to a null-terminated string (with a maximum length of 256 characters) that contains the Windows NT user account of the person who administers this mailbox agent.

Return Values

See Return Values.

See Also

HrCreateMailboxAgentProfile, HrMailboxAgentExists, HrRemoveMailboxAgent