DsListRolesA function

The DsListRoles function lists roles recognized by the server.

Syntax

NTDSAPI DWORD DsListRolesA(
  HANDLE           hDs,
  PDS_NAME_RESULTA *ppRoles
);

Parameters

hDs

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

ppRoles

Pointer to a variable that receives a pointer to a DS_NAME_RESULT structure containing the roles the server recognizes. 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_ROLE_DOMAIN_OWNER

Server owns the domain.

DS_ROLE_INFRASTRUCTURE_OWNER

Server owns the infrastructure.

DS_ROLE_PDC_OWNER

Server owns the PDC.

DS_ROLE_RID_OWNER

Server owns the RID.

DS_ROLE_SCHEMA_OWNER

Server owns the schema.

Return Value

If the function returns a list of roles, the return value is NO_ERROR.

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

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