Platform SDK: Exchange Server

HrInstallGateway

The HrInstallGateway function loads a gateway into a site.

Quick Info

Header file: EXCHINST.H
Library: EXCHINST.LIB

HRESULT HrInstallGateway(
  LPSTR lpszServer,      
  LPSTR lpszSiteDN,      
  LPSTR lpszDisplayName, 
  LPSTR lpszCommonName,  
  LPSTR lpszExtensionName,  
  LPSTR lpszExtensionData,  
  LPSTR lpszAddressType, 
  LPSTR lpszAccountName, 
  BOOL fCanPreserveDNs   
);
 

Parameters

lpszServer
Input parameter. Points to a null-terminated string (with a maximum length of 256 characters) containing the name of the server where the gateway is installed.
lpszSiteDN
Input parameter. Points to a null-terminated string (with a maximum length of 256 characters) containing the distinguished name (DN) of the site where the gateway is installed.
lpszDisplayName
Input parameter. Points to a null-terminated string (with a maximum length of 256 characters) containing the name of the gateway 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.

lpszCommonName
Input parameter. Points to a null-terminated string (with a maximum length of 256 characters) that contains the relative distinguished name (RDN) of the gateway object. Common names have the following format:

extension-name:hardware-platform

For example, suppose you have a gateway called ToNet with an Extension-Name attribute of ToNet. If your platform is Intel, set lpszCommonName to ToNet:i386.

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 gateway.
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.
lpszAddressType
Input parameter. Points to a null-terminated string (with a maximum length of 256 characters) that contains the address type that the gateway supports.
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 the gateway.
fCanPreserveDNs
Input parameter. Determines whether the gateway preserves distinguished names:
TRUE
The gateway preserves distinguished names.
FALSE
The gateway does not preserve distinguished names.

Return Values

See Return Values.

See Also

HrGatewayExists, HrInstallService, HrRemoveGateway