HrInstallAddressTemplate

The HrInstallAddressTemplate function loads an address template into a site.

Quick Info

HRESULT HrInstallAddressTemplate(
  LPSTR lpszServer,       
  LPSTR lpszSiteDN,       
  LPSTR lpszDisplayName,  
  LPSTR lpszCommonName,   
  LPSTR lpszAddressSyntax,  
  LPSTR lpszAddressType,  
  LPSTR lpszPerMessageDDT,  
  LPSTR lpszPerRecipientDDT,  
  LPSTR lpszAddressEntryDDT,  
  LPSTR lpszLanguage,     
  LPSTR lpszHelpData16,   
  LPSTR lpszHelpData32,   
  LPSTR lpszHelpFile      
);
 

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 address template 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 address template is installed.

lpszDisplayName

Input parameter. Points to a null-terminated string (with a maximum length of 256 characters) that contains the name of the address template 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 address template object. Common names have the following format:

extension-name:hardware-platform

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

lpszAddressSyntax

Input parameter. Points to a null-terminated string (with a maximum length of 256 characters) that contains the name of the file that generates the address syntax.

lpszAddressType

Input parameter. Points to a null-terminated string (with a maximum length of 256 characters) that contains the type of address that this template supports.

lpszPerMessageDDT

Input parameter. Points to a null-terminated string (with a maximum length of 256 characters) that contains the per-message dialog file.

lpszPerRecipientDDT

Input parameter. Points to a null-terminated string (with a maximum length of 256 characters) that contains the per-recipient dialog file.

lpszAddressEntryDDT

Input parameter. Points to a null-terminated string (with a maximum length of 256 characters) that contains the per-address entry dialog file.

lpszLanguage

Input parameter. Points to a null-terminated string (with a maximum length of 256 characters) that contains the language supported by the template.

lpszHelpData16

Input parameter. Points to a null-terminated string (with a maximum length of 256 characters) that contains the full path to the file containing the binary Help information for 16-bit clients.

lpszHelpData32

Input parameter. Points to a null-terminated string (with a maximum length of 256 characters) that contains the full path to the file containing the binary Help information for 32-bit clients.

lpszHelpFile

Input parameter. Points to a null-terminated string (with a maximum length of 256 characters) that contains the full path to the client Help program.

Return Values

See Return Values.

See Also

HrAddressTemplateExists, HrRemoveAddressTemplate