DsGetSiteNameA function (dsgetdc.h)
The DsGetSiteName function returns the name of the site where a computer resides. For a domain controller (DC), the name of the site is the location of the configured DC. For a member workstation or member server, the name specifies the workstation site as configured in the domain of the computer.
Syntax
DSGETDCAPI DWORD DsGetSiteNameA(
[in] LPCSTR ComputerName,
[out] LPSTR *SiteName
);
Parameters
[in] ComputerName
Pointer to a null-terminated string that specifies the name of the server to send this function. A NULL implies the local computer.
[out] SiteName
Pointer to a variable that receives a pointer to a null-terminated string specifying the site location of this computer. This string is allocated by the system and must be freed using the NetApiBufferFree function.
Return value
If the function returns account information, the return value is NO_ERROR.
If the function fails, the return value can be one of the following error codes.
Remarks
The DsGetSiteName function does not require any particular access to the specified domain. The function is sent to the "NetLogon" service on the computer specified by ComputerName.
Note
The dsgetdc.h header defines DsGetSiteName 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 | dsgetdc.h |
| Library | Netapi32.lib |
| DLL | Netapi32.dll |