Platform SDK: Active Directory, ADSI, and Directory Services

DsListSites

The DsListSites function lists all the sites in the enterprise.

DWORD DsListSites(
  HANDLE hDs,
  PDS_NAME_RESULTW *ppSites
);

Parameters

hDs
[in] Bind handle to the directory service.
ppSites
[out] Pointer to a variable that receives a pointer to a DS_NAME_RESULT structure containing the list of sites in the enterprise. The returned structure must be deallocated using the DsFreeNameResult function.

Return Values

If the function returns a list of sites, 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 incorrect.
ERROR_NOT_ENOUGH_MEMORY
There is insufficient memory available.

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

Requirements

  Windows NT/2000: Requires Windows 2000.
  Header: Declared in Ntdsapi.h.
  Library: Included as a resource in Ntdsapi.dll.
  Unicode: Implemented as Unicode and ANSI versions on Windows 2000.

See Also

DC and Replication Management Functions, DsFreeNameResult, DS_NAME_RESULT