DsBindToISTGA function (ntdsapi.h)

Article
02/22/2024

The DsBindToISTG function binds to the computer that holds the Inter-Site Topology Generator (ISTG) role in the domain of the local computer.

Syntax

NTDSAPI_POSTXP DWORD DsBindToISTGA(
  [in, optional] LPCSTR SiteName,
  [out]          HANDLE *phDS
);

Parameters

[in, optional] SiteName

Pointer to a null-terminated string that contains the site name used when binding. If this parameter is NULL, the site of the nearest domain controller is used.

[out] phDS

Address of a HANDLE value that receives the bind handle. To close this handle, call DsUnBind.

Return value

Returns ERROR_SUCCESS if successful or a Win32 or RPC error code otherwise. The following are possible error codes.

Remarks

Note

The ntdsapi.h header defines DsBindToISTG 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