DsListDomainsInSiteA function

The DsListDomainsInSite function lists all the domains in a site.

Syntax

NTDSAPI DWORD DsListDomainsInSiteA(
  HANDLE           hDs,
  LPCSTR           site,
  PDS_NAME_RESULTA *ppDomains
);

Parameters

hDs

Contains a directory service handle obtained from either the DSBind or DSBindWithCred function.

site

Pointer to a null-terminated string that specifies the site name. This string is taken from the list of site names returned by the DsListSites function.

ppDomains

Pointer to a pointer to a DS_NAME_RESULT structure that receives the list of domains in the site. To free the returned structure, call the DsFreeNameResult function.

Return Value

If the function returns a list of domains, the return value is NO_ERROR. If the function fails, the return value can be one of the following error codes.

Remarks

Individual name conversion errors are reported in the returned DS_NAME_RESULT structure.

Requirements

   
Minimum supported client Windows Vista
Minimum supported server Windows Server 2008
Target Platform Windows
Header ntdsapi.h
Library Ntdsapi.lib
DLL Ntdsapi.dll

See Also

DS_NAME_RESULT

Domain Controller and Replication Management Functions

DsFreeNameResult