DAPIGetSiteInfo

The DAPIGetSiteInfo function retrieves the site information for a directory service agent.

Quick Info

Header file: DAPI.H
Library: DAPI.LIB
Unicode: Yes 

PDAPI_EVENT DAPIGetSiteInfo(
  DWORD dwFlags,           
  LPTSTR pszDSA,           
  PSITE_INFO * ppSiteInfo  
);

Parameters

dwFlags
Input parameter. Reserved for future use.
pszDSA
Input parameter. Points to the name of the directory service agent (Microsoft Exchange Server name) from which to retrieve information.
ppSiteInfo
Output parameter. Points to a SITE_INFO structure.

Return Values

NULL
No errors were encountered.
A pointer to a DAPI_EVENT structure
An error was encountered.

Remarks

If the DAPIGetSiteInfo function fails and returns a pointer to a DAPI_EVENT, you must free the memory allocated for that structure with a call to the DAPIFreeMemory function.

For more information on this function, see Using Directory Access Functions.

See Also

DAPIFreeMemory