DsListSitesA function (ntdsapi.h)
The DsListSites function lists all the sites in the enterprise forest.
Syntax
NTDSAPI DWORD DsListSitesA(
[in] HANDLE hDs,
[out] PDS_NAME_RESULTA *ppSites
);
Parameters
[in] hDs
Contains a directory service handle obtained from either the DSBind or DSBindWithCred function.
[out] ppSites
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.
Remarks
Individual name conversion errors are reported in the returned DS_NAME_RESULT structure.
Note
The ntdsapi.h header defines DsListSites as an alias that automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that is not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows Vista |
| Minimum supported server | Windows Server 2008 |
| Target Platform | Windows |
| Header | ntdsapi.h |
| Library | Ntdsapi.lib |
| DLL | Ntdsapi.dll |