Export (0) Print
Expand All

DsListServersInSite function

The DsListServersInSite function lists all the servers in a site.

Syntax


DWORD DsListServersInSite(
  _In_   HANDLE hDs,
  _In_   LPTSTR site,
  _Out_  PDS_NAME_RESULT *ppServers
);

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. The site name uses a distinguished name format. It is taken from the list of sites returned by the DsListSites function.

ppServers [out]

Pointer to a pointer to a DS_NAME_RESULT structure that receives the list of servers in the site. The returned structure must be freed using the DsFreeNameResult function.

Return value

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

Return codeDescription
ERROR_INVALID_PARAMETER

A parameter is invalid.

ERROR_NOT_ENOUGH_MEMORY

There is insufficient memory available.

 

Remarks

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

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Redistributable

Active Directory Client Extension on Windows NT 4.0 and Windows Me/98/95

Header

Ntdsapi.h

Library

Ntdsapi.lib

DLL

Ntdsapi.dll

Unicode and ANSI names

DsListServersInSiteW (Unicode) and DsListServersInSiteA (ANSI)

See also

Domain Controller and Replication Management Functions
DS_NAME_RESULT
DsFreeNameResult

 

 

Show:
© 2014 Microsoft