DsListSites function
The DsListSites function lists all the sites in the enterprise forest.
Syntax
DWORD DsListSites( _In_ HANDLE hDs, _Out_ PDS_NAME_RESULT *ppSites );
Parameters
- hDs [in]
-
Contains a directory service handle obtained from either the DSBind or DSBindWithCred function.
- ppSites [out]
-
Pointer to a pointer to a DS_NAME_RESULT structure that receives the list of sites in the enterprise. The site name is returned in the distinguished name (DN) format. The returned structure must be freed using the DsFreeNameResult function.
Return value
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.
| Return code | Description |
|---|---|
|
A parameter is invalid. |
|
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 |
|
|
Library |
|
|
DLL |
|
|
Unicode and ANSI names | DsListSitesW (Unicode) and DsListSitesA (ANSI) |
See also
Send comments about this topic to Microsoft
Build date: 10/26/2012
