ntdsapi.h 标头

此标头由多种技术使用。 有关详细信息，请参阅：

• Active Directory 域服务
• Active Directory 轻型目录服务

ntdsapi.h 包含以下编程接口：

函数

DsAddSidHistoryA 从一个域中检索安全主体的主帐户安全标识符 (SID) ，并将其添加到另一个林中另一个域中安全主体的 sIDHistory 属性。 (ANSI)
DsAddSidHistoryW 从一个域中检索安全主体的主帐户安全标识符 (SID) ，并将其添加到另一个林中另一个域中安全主体的 sIDHistory 属性。 (Unicode)
DsBindA 绑定到域控制器。 (ANSI)
DsBindByInstanceA 显式绑定到任何 AD LDS 或 Active Directory 实例。 (ANSI)
DsBindByInstanceW 显式绑定到任何 AD LDS 或 Active Directory 实例。 (Unicode)
DsBindingSetTimeout DsBindingSetTimeout 函数设置使用指定绑定句柄的所有 RPC 调用所遵循的超时值。 需要超过超时值时间的 RPC 调用将被取消。
DsBindToISTGA 绑定到在本地计算机的域中拥有 Inter-Site 拓扑生成器 (ISTG) 角色的计算机。 (ANSI)
DsBindToISTGW 绑定到在本地计算机的域中拥有 Inter-Site 拓扑生成器 (ISTG) 角色的计算机。 (Unicode)
DsBindW 绑定到域控制器。 (Unicode)
DsBindWithCredA 使用指定的凭据绑定到域控制器。 (ANSI)
DsBindWithCredW 使用指定的凭据绑定到域控制器。 (Unicode)
DsBindWithSpnA 使用指定的凭据和特定的服务主体名称绑定到域控制器， (SPN) 进行相互身份验证。 (DsBindWithSpnA)
DsBindWithSpnExA 使用指定的凭据和特定的服务主体名称绑定到域控制器， (SPN) 进行相互身份验证。 (DsBindWithSpnExA)
DsBindWithSpnExW 使用指定的凭据和特定的服务主体名称绑定到域控制器， (SPN) 进行相互身份验证。 (DsBindWithSpnExW)
DsBindWithSpnW 使用指定的凭据和特定的服务主体名称绑定到域控制器， (SPN) 进行相互身份验证。 (DsBindWithSpnW)
DsClientMakeSpnForTargetServerA 构造服务主体名称 (SPN) ，用于标识要用于身份验证的特定服务器。 (ANSI)
DsClientMakeSpnForTargetServerW 构造服务主体名称 (SPN) ，用于标识要用于身份验证的特定服务器。 (Unicode)
DsCrackNamesA 将目录服务对象名称数组从一种格式转换为另一种格式。 (ANSI)
DsCrackNamesW 将目录服务对象名称数组从一种格式转换为另一种格式。 (Unicode)
DsFreeDomainControllerInfoA DsFreeDomainControllerInfo 函数释放 DsGetDomainControllerInfo 为域中域控制器的数据分配的内存。 (ANSI)
DsFreeDomainControllerInfoW DsFreeDomainControllerInfo 函数释放 DsGetDomainControllerInfo 为域中域控制器的数据分配的内存。 (Unicode)
DsFreeNameResultA 释放由 DS_NAME_RESULT 结构持有的内存。 (ANSI)
DsFreeNameResultW 释放由 DS_NAME_RESULT 结构持有的内存。 (Unicode)
DsFreePasswordCredentials 释放 DsMakePasswordCredentials 函数为凭据结构分配的内存。
DsFreeSchemaGuidMapA 释放 DsMapSchemaGuids 函数为DS_SCHEMA_GUID_MAP结构分配的内存。 (ANSI)
DsFreeSchemaGuidMapW 释放 DsMapSchemaGuids 函数为DS_SCHEMA_GUID_MAP结构分配的内存。 (Unicode)
DsFreeSpnArrayA 释放从 DsGetSpn 函数返回的数组。 (ANSI)
DsFreeSpnArrayW 释放从 DsGetSpn 函数返回的数组。 (Unicode)
DsGetDomainControllerInfoA 检索有关域中域控制器的数据。 (ANSI)
DsGetDomainControllerInfoW 检索有关域中域控制器的数据。 (Unicode)
DsGetSpnA DsGetSpn 函数构造一个或多个服务主体名称的数组， (SPN) 。 数组中的每个名称都标识服务的实例。 可以使用 DsWriteAccountSpn 函数将这些 SPN 注册到目录服务 (DS) 。 (ANSI)
DsGetSpnW DsGetSpn 函数构造一个或多个服务主体名称的数组， (SPN) 。 数组中的每个名称都标识服务的实例。 可以使用 DsWriteAccountSpn 函数将这些 SPN 注册到目录服务 (DS) 。 (Unicode)
DsInheritSecurityIdentityA 将 SrcPrincipal 的 objectSid 和 sidHistory 属性追加到 DstPrincipal 的 sidHistory，然后删除 SrcPrincipal，所有这些操作都在单个事务中。 (ANSI)
DsInheritSecurityIdentityW 将 SrcPrincipal 的 objectSid 和 sidHistory 属性追加到 DstPrincipal 的 sidHistory，然后删除 SrcPrincipal，所有这些操作都在单个事务中。 (Unicode)
DsListDomainsInSiteA 列出网站中的所有域。 (ANSI)
DsListDomainsInSiteW 列出网站中的所有域。 (Unicode)
DsListInfoForServerA DsListInfoForServer 函数列出服务器的杂项数据。 (ANSI)
DsListInfoForServerW DsListInfoForServer 函数列出服务器的杂项数据。 (Unicode)
DsListRolesA DsListRoles 函数列出服务器识别的角色。 (ANSI)
DsListRolesW DsListRoles 函数列出服务器识别的角色。 (Unicode)
DsListServersForDomainInSiteA 列出站点中某个域中的所有服务器。 (ANSI)
DsListServersForDomainInSiteW 列出站点中某个域中的所有服务器。 (Unicode)
DsListServersInSiteA 列出站点中的所有服务器。 (ANSI)
DsListServersInSiteW 列出站点中的所有服务器。 (Unicode)
DsListSitesA 列出企业林中的所有站点。 (ANSI)
DsListSitesW 列出企业林中的所有站点。 (Unicode)
DsMakePasswordCredentialsA 构造适合与 DsBindWithCred 函数一起使用的凭据句柄。 (ANSI)
DsMakePasswordCredentialsW 构造适合与 DsBindWithCred 函数一起使用的凭据句柄。 (Unicode)
DsMapSchemaGuidsA 将目录服务架构对象的 GUID 转换为其显示名称。 (ANSI)
DsMapSchemaGuidsW 将目录服务架构对象的 GUID 转换为其显示名称。 (Unicode)
DsQuerySitesByCostA 获取一个站点与一个或多个其他站点之间的通信成本。 (ANSI)
DsQuerySitesByCostW 获取一个站点与一个或多个其他站点之间的通信成本。 (Unicode)
DsQuerySitesFree 释放 DsQuerySitesByCost 函数分配的内存。
DsRemoveDsDomainA 从目录服务的全局区域中删除域命名上下文的所有跟踪。 (ANSI)
DsRemoveDsDomainW 从目录服务的全局区域中删除域命名上下文的所有跟踪。 (Unicode)
DsRemoveDsServerA DsRemoveDsServer 函数从目录服务的全局区域中删除目录服务代理 (DSA) 的所有跟踪。 (ANSI)
DsRemoveDsServerW DsRemoveDsServer 函数从目录服务的全局区域中删除目录服务代理 (DSA) 的所有跟踪。 (Unicode)
DsReplicaAddA 将复制源引用添加到目标命名上下文。 (ANSI)
DsReplicaAddW 将复制源引用添加到目标命名上下文。 (Unicode)
DsReplicaConsistencyCheck 调用知识一致性检查器 (KCC) 来验证复制拓扑。
DsReplicaDelA 从目标命名上下文中删除复制源引用 (NC) 。 (ANSI)
DsReplicaDelW 从目标命名上下文中删除复制源引用 (NC) 。 (Unicode)
DsReplicaFreeInfo 释放由 DsReplicaGetInfo 或 DsReplicaGetInfo2 函数分配的复制状态数据结构。
DsReplicaGetInfo2W 从目录服务检索复制状态数据。 此函数允许在检索超过 1000 个条目的情况下对结果进行分页。
DsReplicaGetInfoW 从目录服务检索复制状态数据。
DsReplicaModifyA 修改目标命名上下文的现有复制源引用。 (ANSI)
DsReplicaModifyW 修改目标命名上下文的现有复制源引用。 (Unicode)
DsReplicaSyncA 将目标命名上下文 (NC) 与其源之一同步。 (ANSI)
DsReplicaSyncAllA 根据需要使用可传递复制将服务器与所有其他服务器同步。 (ANSI)
DsReplicaSyncAllW 根据需要使用可传递复制将服务器与所有其他服务器同步。 (Unicode)
DsReplicaSyncW 将目标命名上下文 (NC) 与其源之一同步。 (Unicode)
DsReplicaUpdateRefsA 在源命名上下文中添加或删除目标的复制引用。 (ANSI)
DsReplicaUpdateRefsW 在源命名上下文中添加或删除目标的复制引用。 (Unicode)
DsReplicaVerifyObjectsA 验证具有源的命名上下文的所有对象。 (ANSI)
DsReplicaVerifyObjectsW 验证具有源的命名上下文的所有对象。 (Unicode)
DsServerRegisterSpnA DsServerRegisterSpn 函数为基于主机的服务组成两个 SPN。 (ANSI)
DsServerRegisterSpnW DsServerRegisterSpn 函数为基于主机的服务组成两个 SPN。 (Unicode)
DsUnBindA DsUnBind 函数查找具有域控制器的 RPC 会话，并将目录服务的句柄取消绑定， (DS) 。 (ANSI)
DsUnBindW DsUnBind 函数查找具有域控制器的 RPC 会话，并将目录服务的句柄取消绑定， (DS) 。 (Unicode)
DsWriteAccountSpnA 将服务主体名称数组 (SPN) 写入Active Directory 域服务中指定用户或计算机帐户对象的 servicePrincipalName 属性。 (ANSI)
DsWriteAccountSpnW 将服务主体名称数组 (SPN) 写入Active Directory 域服务中指定用户或计算机帐户对象的 servicePrincipalName 属性。 (Unicode)

结构

DS_DOMAIN_CONTROLLER_INFO_1A DS_DOMAIN_CONTROLLER_INFO_1结构包含有关域控制器的数据。 此结构由 DsGetDomainControllerInfo 函数返回。 (ANSI)
DS_DOMAIN_CONTROLLER_INFO_1W DS_DOMAIN_CONTROLLER_INFO_1结构包含有关域控制器的数据。 此结构由 DsGetDomainControllerInfo 函数返回。 (Unicode)
DS_DOMAIN_CONTROLLER_INFO_2A DS_DOMAIN_CONTROLLER_INFO_2结构包含有关域控制器的数据。 此结构由 DsGetDomainControllerInfo 函数返回。 (ANSI)
DS_DOMAIN_CONTROLLER_INFO_2W DS_DOMAIN_CONTROLLER_INFO_2结构包含有关域控制器的数据。 此结构由 DsGetDomainControllerInfo 函数返回。 (Unicode)
DS_DOMAIN_CONTROLLER_INFO_3A DS_DOMAIN_CONTROLLER_INFO_3结构包含有关域控制器的数据。 此结构由 DsGetDomainControllerInfo 函数返回。 (ANSI)
DS_DOMAIN_CONTROLLER_INFO_3W DS_DOMAIN_CONTROLLER_INFO_3结构包含有关域控制器的数据。 此结构由 DsGetDomainControllerInfo 函数返回。 (Unicode)
DS_NAME_RESULT_ITEMA DS_NAME_RESULT_ITEM 结构包含由 DsCrackNames 函数转换的名称，以及关联的错误和域数据。 (ANSI)
DS_NAME_RESULT_ITEMW DS_NAME_RESULT_ITEM 结构包含由 DsCrackNames 函数转换的名称，以及关联的错误和域数据。 (Unicode)
DS_NAME_RESULTA DS_NAME_RESULT 结构与 DsCrackNames 函数一起使用，以包含函数转换的名称。 (ANSI)
DS_NAME_RESULTW DS_NAME_RESULT 结构与 DsCrackNames 函数一起使用，以包含函数转换的名称。 (Unicode)
DS_REPL_ATTR_META_DATA DS_REPL_ATTR_META_DATA 结构与 DsReplicaGetInfo 和 DsReplicaGetInfo2 函数一起使用，以包含对象属性的复制状态数据。
DS_REPL_ATTR_META_DATA_2 DS_REPL_ATTR_META_DATA_2 结构与 DsReplicaGetInfo 和 DsReplicaGetInfo2 函数一起使用，以包含对象属性的复制状态数据。
DS_REPL_ATTR_META_DATA_BLOB DS_REPL_ATTR_META_DATA_BLOB 结构用于包含对象属性的复制状态数据。
DS_REPL_ATTR_VALUE_META_DATA DS_REPL_ATTR_VALUE_META_DATA 结构与 DsReplicaGetInfo2 函数一起使用，为属性值集合提供元数据。
DS_REPL_ATTR_VALUE_META_DATA_2 与 DsReplicaGetInfo2 函数一起使用，为属性值集合提供元数据。
DS_REPL_ATTR_VALUE_META_DATA_EXT 为属性复制值的集合提供元数据。
DS_REPL_CURSOR DS_REPL_CURSOR 结构包含与给定命名上下文的所有副本相关的入站复制状态数据，由 DsReplicaGetInfo 和 DsReplicaGetInfo2 函数返回。
DS_REPL_CURSOR_2 DS_REPL_CURSOR_2 结构包含与 DsReplicaGetInfo2 函数返回的给定命名上下文的所有副本相关的入站复制状态数据。 此结构是DS_REPL_CURSOR结构的增强版本。
DS_REPL_CURSOR_3W DS_REPL_CURSOR_3 结构包含与给定命名上下文的所有副本相关的入站复制状态数据，由 DsReplicaGetInfo2 函数返回。
DS_REPL_CURSOR_BLOB DS_REPL_CURSOR_BLOB 结构包含与给定命名上下文的所有副本相关的入站复制状态数据。
DS_REPL_CURSORS DS_REPL_CURSORS 结构与 DsReplicaGetInfo 和 DsReplicaGetInfo2 函数一起使用，以提供与给定命名上下文的所有副本相关的复制状态数据。
DS_REPL_CURSORS_2 DS_REPL_CURSORS_2 结构与 DsReplicaGetInfo2 函数一起使用，以提供与给定命名上下文的所有副本相关的复制状态数据。
DS_REPL_CURSORS_3W DS_REPL_CURSORS_3结构与 DsReplicaGetInfo2 函数一起使用，以提供与给定命名上下文的所有副本相关的复制状态数据。
DS_REPL_KCC_DSA_FAILURESW DS_REPL_KCC_DSA_FAILURES 结构包含DS_REPL_KCC_DSA_FAILURE结构的数组，这些结构又包含 DsReplicaGetInfo 和 DsReplicaGetInfo2 函数返回的与入站复制伙伴相关的复制状态数据。
DS_REPL_KCC_DSA_FAILUREW DS_REPL_KCC_DSA_FAILURE 结构包含有关特定入站复制伙伴的复制状态数据，由 DsReplicaGetInfo 和 DsReplicaGetInfo2 函数返回。
DS_REPL_KCC_DSA_FAILUREW_BLOB 包含与特定入站复制伙伴相关的复制状态数据。
DS_REPL_NEIGHBORSW DS_REPL_NEIGHBORS 结构与 DsReplicaGetInfo 和 DsReplicaGetInfo2 函数一起使用，为命名上下文和源服务器对提供入站复制状态数据。
DS_REPL_NEIGHBORW 包含由 DsReplicaGetInfo 和 DsReplicaGetInfo2 函数返回的特定命名上下文和源服务器对的入站复制状态数据。
DS_REPL_NEIGHBORW_BLOB 包含特定命名上下文和源服务器对的入站复制状态数据。
DS_REPL_OBJ_META_DATA DS_REPL_OBJ_META_DATA 结构包含DS_REPL_ATTR_META_DATA结构的数组。 这些结构包含给定对象的过去和当前属性的复制状态数据。
DS_REPL_OBJ_META_DATA_2 DS_REPL_OBJ_META_DATA_2 结构包含DS_REPL_ATTR_META_DATA_2结构的数组，这些结构又包含给定对象的过去和当前) (属性的复制状态数据，由 DsReplicaGetInfo2 函数返回。
DS_REPL_OPW DS_REPL_OP结构描述当前正在执行或挂起执行的复制任务，由 DsReplicaGetInfo 或 DsReplicaGetInfo2 函数返回。
DS_REPL_OPW_BLOB DS_REPL_OPW_BLOB结构描述当前正在执行或挂起执行的复制任务。
DS_REPL_PENDING_OPSW 包含DS_REPL_OP结构的数组，这些结构又描述当前正在执行的复制任务，并按 DsReplicaGetInfo 和 DsReplicaGetInfo2 函数返回。
DS_REPL_QUEUE_STATISTICSW 用于包含复制队列统计信息。
DS_REPL_VALUE_META_DATA 与 DS_REPL_ATTR_VALUE_META_DATA 结构一起使用，以包含属性值复制元数据。
DS_REPL_VALUE_META_DATA_2 与 DS_REPL_ATTR_VALUE_META_DATA_2 结构一起使用，以包含属性值复制元数据。
DS_REPL_VALUE_META_DATA_BLOB 用于包含属性值复制元数据。
DS_REPL_VALUE_META_DATA_BLOB_EXT 包含属性值复制元数据。
DS_REPL_VALUE_META_DATA_EXT 包含DS_REPL_ATTR_VALUE_META_DATA_EXT结构的属性复制元数据。
DS_REPSYNCALL_ERRINFOA DS_REPSYNCALL_ERRINFO 结构与 DS_REPSYNCALL_UPDATE 结构一起使用，以包含复制期间 DsReplicaSyncAll 函数生成的错误。 (ANSI)
DS_REPSYNCALL_ERRINFOW DS_REPSYNCALL_ERRINFO 结构与 DS_REPSYNCALL_UPDATE 结构一起使用，以包含复制期间 DsReplicaSyncAll 函数生成的错误。 (Unicode)
DS_REPSYNCALL_SYNCA DS_REPSYNCALL_SYNC 结构标识 DsReplicaSyncAll 函数在源和目标服务器之间执行的单个复制操作。 (ANSI)
DS_REPSYNCALL_SYNCW DS_REPSYNCALL_SYNC 结构标识 DsReplicaSyncAll 函数在源和目标服务器之间执行的单个复制操作。 (Unicode)
DS_REPSYNCALL_UPDATEA DS_REPSYNCALL_UPDATE 结构包含有关 DsReplicaSyncAll 函数执行的复制的状态数据。 (ANSI)
DS_REPSYNCALL_UPDATEW DS_REPSYNCALL_UPDATE 结构包含有关 DsReplicaSyncAll 函数执行的复制的状态数据。 (Unicode)
DS_SCHEMA_GUID_MAPA 包含对 DsMapSchemaGuids 的调用结果。 (ANSI)
DS_SCHEMA_GUID_MAPW 包含对 DsMapSchemaGuids 的调用结果。 (Unicode)
DS_SITE_COST_INFO DS_SITE_COST_INFO 结构与 DsQuerySitesByCost 函数一起使用，以包含通信成本数据。

枚举

DS_KCC_TASKID 指定知识一致性检查器 (KCC) 可以执行的任务。
DS_NAME_ERROR DS_NAME_ERROR枚举定义DS_NAME_RESULT_ITEM结构的状态成员返回的错误。 这些是 DsCrackNames 函数转换名称时可能遇到的潜在错误。
DS_NAME_FLAGS DS_NAME_FLAGS枚举用于定义如何破解名称语法。 DsCrackNames 函数使用这些标志。
DS_NAME_FORMAT DS_NAME_FORMAT 枚举提供用于 DsCrackNames 函数输入和输出名称的格式。
DS_REPL_INFO_TYPE DS_REPL_INFO_TYPE枚举与 DsReplicaGetInfo 和 DsReplicaGetInfo2 函数一起使用，以指定要检索的复制数据类型。
DS_REPL_OP_TYPE 用于指示复制队列中给定条目所表示的复制操作的类型。
DS_REPSYNCALL_ERROR DS_REPSYNCALL_ERROR 枚举与 DS_REPSYNCALL_ERRINFO 结构一起使用，以指示复制过程中发生错误的位置。
DS_REPSYNCALL_EVENT DS_REPSYNCALL_EVENT 枚举与 DS_REPSYNCALL_UPDATE 结构一起使用，以定义DS_REPSYNCALL_UPDATE结构表示的事件。
DS_SPN_NAME_TYPE dsGetSPN 函数使用DS_SPN_NAME_TYPE枚举来标识编写 SPN 的格式。
DS_SPN_WRITE_OP DS_SPN_WRITE_OP枚举标识应由 DsWriteAccountSpn 函数执行的写入操作的类型。