DsListDomainsInSite

DsListDomainsInSite function

The DsListDomainsInSite function lists all the domains in a site.

Syntax


DWORD DsListDomainsInSite(
  _In_  HANDLE          hDs,
  _In_  LPTSTR          site,
  _Out_ PDS_NAME_RESULT *ppDomains
);

Parameters

hDs [in]

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

site [in]

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 [out]

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.

ERROR_INVALID_PARAMETER

A parameter is invalid.

ERROR_NOT_ENOUGH_MEMORY

There is insufficient memory available to complete the operation.

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

Header

Ntdsapi.h

Library

Ntdsapi.lib

DLL

Ntdsapi.dll

Unicode and ANSI names

DsListDomainsInSiteW (Unicode) and DsListDomainsInSiteA (ANSI)

See also

Domain Controller and Replication Management Functions
DS_NAME_RESULT
DsFreeNameResult

 

 

Show:
© 2016 Microsoft