DsGetSiteName

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.

DWORD DsGetSiteName(
  LPCTSTR ComputerName,
  LPTSTR* SiteName
);

Parameters

ComputerName

[in] Pointer to a null-terminated string that specifies the name of the server to send this function. A NULL implies the local computer.

SiteName

[out] 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 Values

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.

Requirements

Client: Included in Windows XP and Windows 2000 Professional.
Server: Included in Windows Server 2003 and Windows 2000 Server.
Unicode: Implemented as Unicode and ANSI versions.
Header: Declared in Dsgetdc.h.
Library: Use Netapi32.lib.

See Also

Directory Service Functions, DsGetDcName, DSValidateSubnetName, NetApiBufferFree