Export (0) Print
Expand All

DsGetSiteName function

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


DWORD DsGetSiteName(
  _In_   LPCTSTR ComputerName,
  _Out_  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 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.

Return codeDescription
ERROR_NO_SITENAME

The computer is not in a site.

ERROR_NOT_ENOUGH_MEMORY

Insufficient memory is available.

 

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

Minimum supported client

Windows Vista

Minimum supported server

Windows Server 2003

Header

Dsgetdc.h

Library

Netapi32.lib

DLL

Netapi32.dll

Unicode and ANSI names

DsGetSiteNameW (Unicode) and DsGetSiteNameA (ANSI)

See also

Directory Service Functions
DsGetDcName
DsValidateSubnetName
NetApiBufferFree

 

 

Show:
© 2014 Microsoft