DsListInfoForServerA function

The DsListInfoForServer function lists miscellaneous data for a server.

Syntax

NTDSAPI DWORD DsListInfoForServerA(
  HANDLE           hDs,
  LPCSTR           server,
  PDS_NAME_RESULTA *ppInfo
);

Parameters

hDs

Contains a directory service handle obtained from either the DSBind or DSBindWithCred function.

server

Pointer to a null-terminated string that specifies the server name. This name must be the same as one of the strings returned by the DsListServersForDomainInSite or DsListServersInSite function.

ppInfo

Pointer to a variable that receives a pointer to a DS_NAME_RESULT structure that contains the server data. The returned structure must be deallocated using DsFreeNameResult.

The indexes of the array in the DS_NAME_RESULT structure indicate what data are contained by each array element. The following constants may be used to specify the desired index for a particular piece of data.

DS_LIST_ACCOUNT_OBJECT_FOR_SERVER

Name of the account object for the domain controller (DC).

DS_LIST_DNS_HOST_NAME_FOR_SERVER

DNS host name of the DC.

DS_LIST_DSA_OBJECT_FOR_SERVER

GUID of the directory service agent (DSA) for the domain controller (DC).

Return Value

If the function returns server data, the return value is NO_ERROR.

If the function fails, the return value can be one of the following error codes.

Remarks

Individual name conversion errors are reported in the returned DS_NAME_RESULT structure.

Requirements

   
Minimum supported client Windows Vista
Minimum supported server Windows Server 2008
Target Platform Windows
Header ntdsapi.h
Library Ntdsapi.lib
DLL Ntdsapi.dll

See Also

DS_NAME_RESULT

Domain Controller and Replication Management Functions

DsFreeNameResult