DsListDomainsInSiteA function (ntdsapi.h)
The DsListDomainsInSite function lists all the domains in a site.
Syntax
NTDSAPI DWORD DsListDomainsInSiteA(
[in] HANDLE hDs,
[in] LPCSTR site,
[out] PDS_NAME_RESULTA *ppDomains
);
Parameters
[in] hDs
Contains a directory service handle obtained from either the DSBind or DSBindWithCred function.
[in] site
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.
[out] ppDomains
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.
Remarks
Individual name conversion errors are reported in the returned DS_NAME_RESULT structure.
Note
The ntdsapi.h header defines DsListDomainsInSite as an alias which 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 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 |