Export (0) Print
Expand All

DsListInfoForServer function

The DsListInfoForServer function lists miscellaneous data for a server.

Syntax


DWORD DsListInfoForServer(
  _In_   HANDLE hDs,
  _In_   LPTSTR server,
  _Out_  PDS_NAME_RESULT *ppInfo
);

Parameters

hDs [in]

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

server [in]

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

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.

ValueMeaning
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.

Return codeDescription
ERROR_INVALID_PARAMETER

A parameter is invalid.

ERROR_NOT_ENOUGH_MEMORY

There is insufficient memory available.

 

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 2003

Header

Ntdsapi.h

Library

Ntdsapi.lib

DLL

Ntdsapi.dll

Unicode and ANSI names

DsListInfoForServerW (Unicode) and DsListInfoForServerA (ANSI)

See also

Domain Controller and Replication Management Functions
DS_NAME_RESULT
DsFreeNameResult

 

 

Show:
© 2014 Microsoft