DS_DOMAIN_CONTROLLER_INFO_2A structure (ntdsapi.h)

The DS_DOMAIN_CONTROLLER_INFO_2 structure contains data about a domain controller. This structure is returned by the DsGetDomainControllerInfo function.

Syntax

typedef struct {
#if ...
  CHAR  *NetbiosName;
#if ...
  CHAR  *DnsHostName;
#if ...
  CHAR  *SiteName;
#if ...
  CHAR  *SiteObjectName;
#if ...
  CHAR  *ComputerObjectName;
#if ...
  CHAR  *ServerObjectName;
#if ...
  CHAR  *NtdsDsaObjectName;
#else
  LPSTR NetbiosName;
#endif
#else
  LPSTR DnsHostName;
#endif
#else
  LPSTR SiteName;
#endif
#else
  LPSTR SiteObjectName;
#endif
#else
  LPSTR ComputerObjectName;
#endif
#else
  LPSTR ServerObjectName;
#endif
#else
  LPSTR NtdsDsaObjectName;
#endif
  BOOL  fIsPdc;
  BOOL  fDsEnabled;
  BOOL  fIsGc;
  GUID  SiteObjectGuid;
  GUID  ComputerObjectGuid;
  GUID  ServerObjectGuid;
  GUID  NtdsDsaObjectGuid;
} DS_DOMAIN_CONTROLLER_INFO_2A, *PDS_DOMAIN_CONTROLLER_INFO_2A;

Members

NetbiosName

Pointer to a null-terminated string that specifies the NetBIOS name of the domain controller.

DnsHostName

Pointer to a null-terminated string that specifies the DNS host name of the domain controller.

SiteName

Pointer to a null-terminated string that specifies the site to which the domain controller belongs.

SiteObjectName

Pointer to a null-terminated string that specifies the name of the site object on the domain controller.

ComputerObjectName

Pointer to a null-terminated string that specifies the name of the computer object on the domain controller.

ServerObjectName

Pointer to a null-terminated string that specifies the name of the server object on the domain controller.

NtdsDsaObjectName

Pointer to a null-terminated string that specifies the name of the NTDS DSA object on the domain controller.

fIsPdc

A Boolean value that indicates whether or not this domain controller is the primary domain controller. If this value is TRUE, the domain controller is the primary domain controller; otherwise, the domain controller is not the primary domain controller.

fDsEnabled

A Boolean value that indicates whether or not the domain controller is enabled. If this value is TRUE, the domain controller is enabled; otherwise, it is not enabled.

fIsGc

A Boolean value that indicates whether or not the domain controller is global catalog server. If this value is TRUE, the domain controller is a global catalog server; otherwise, it is not a global catalog server.

SiteObjectGuid

Contains the GUID for the site object on the domain controller.

ComputerObjectGuid

Contains the GUID for the computer object on the domain controller.

ServerObjectGuid

Contains the GUID for the server object on the domain controller.

NtdsDsaObjectGuid

Contains the GUID for the NTDS DSA object on the domain controller.

Remarks

The DsGetDomainControllerInfo function can return different versions of this structure. For more information and a list of the currently supported versions, see the InfoLevel parameter of DsGetDomainControllerInfo.

Note

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

See also

Domain Controller and Replication Management Structures

DsGetDomainControllerInfo