DsReplicaModifyA 函数 (ntdsapi.h)

项目
08/25/2023

DsReplicaModify 函数修改目标命名上下文的现有复制源引用。

语法

NTDSAPI DWORD DsReplicaModifyA(
  [in] HANDLE          hDS,
  [in] LPCSTR          NameContext,
  [in] const UUID      *pUuidSourceDsa,
  [in] LPCSTR          TransportDn,
  [in] LPCSTR          SourceDsaAddress,
  [in] const PSCHEDULE pSchedule,
  [in] DWORD           ReplicaFlags,
  [in] DWORD           ModifyFields,
  [in] DWORD           Options
);

参数

[in] hDS

包含从 DSBind 或 DSBindWithCred 函数获取的目录服务句柄。

[in] NameContext

指向以 null 结尾的常量字符串的指针，该字符串指定目标命名上下文 (NC) 的可分辨名称 (DN) 。

[in] pUuidSourceDsa

指向源目录系统代理的 UUID 的指针 (DSA) 。如果 ModifyFields 不包含 DS_REPMOD_UPDATE_ADDRESS 并且 SourceDsaAddress 不为 NULL，则此参数可能为 null。

[in] TransportDn

保留供将来使用。 除 NULL 以外的任何值都会导致返回ERROR_NOT_SUPPORTED。

[in] SourceDsaAddress

指向常量以 null 结尾的 Unicode 字符串的指针，该字符串指定源 DSA 的特定于传输的地址。如果 pUuidSourceDsa 不为 NULL 且 ModifyFields 不包含 DS_REPMOD_UPDATE_ADDRESS，则忽略此参数。

[in] pSchedule

指向 SCHEDULE 结构的指针，该结构包含复制源的复制计划数据。此参数是可选的，如果未使用，可以为 NULL 。如果 ModifyFields 包含 DS_REPMOD_UPDATE_SCHEDULE 标志，则此参数是必需的。

[in] ReplicaFlags

此参数用于控制复制行为，可以采用以下值。

DS_REPL_NBR_SYNC_ON_STARTUP

当启动目标服务器时，将尝试从此源复制此命名上下文。通常，此选项仅适用于站点内的邻居。

DS_REPL_NBR_DO_SCHEDULED_SYNCS

按计划执行复制。通常设置此标志，除非此命名上下文和源的计划为“永不”，即空计划。

DS_REPL_NBR_TWO_WAY_SYNC

如果设置，则指示入站复制完成后，目标服务器必须告知源服务器反向同步。此功能在拨号方案中使用。在拨号方案中，只有两个服务器中的一个可以启动拨号连接。例如，在公司总部和分公司中可以使用此选项，分公司通过拨号 ISP 连接经由 Internet 连接到公司总部。

DS_REPL_NBR_IGNORE_CHANGE_NOTIFICATIONS

此邻居设置为禁用基于通知的同步。在某个站点内，域控制器在发生更改时根据通知彼此进行同步。此设置可防止此邻居执行由通知触发的同步。邻居仍将根据其计划或响应手动请求的同步来执行同步。

DS_REPL_NBR_DISABLE_SCHEDULED_SYNC

此邻居设置为不根据其计划执行同步。此邻居执行同步的唯一方法是响应更改通知或手动请求的同步。

DS_REPL_NBR_COMPRESS_CHANGES

将从此源收到的更改进行压缩。通常，仅当源服务器位于其他站点时，才会设置此值。

DS_REPL_NBR_NO_CHANGE_NOTIFICATIONS

不应从此源接收任何更改通知。通常，仅当源服务器位于其他站点时，才会设置此值。

[in] ModifyFields

指定应修改的字段。必须在 ModifyFields 中指定至少一个字段。此参数可以是以下值的组合。

DS_REPMOD_UPDATE_ADDRESS

汇报与引用的服务器关联的地址。

DS_REPMOD_UPDATE_FLAGS

汇报与副本 (replica) 关联的标志。

DS_REPMOD_UPDATE_RESULT

未使用。目前不支持指定结果值的更新。结果值默认为 0。

DS_REPMOD_UPDATE_SCHEDULE

汇报与副本 (replica) 关联的定期复制计划。

DS_REPMOD_UPDATE_TRANSPORT

汇报与副本 (replica) 关联的传输。

[in] Options

传递用于处理请求的其他数据。此参数可以是以下值的组合。

DS_REPMOD_ASYNCHRONOUS_OPERATION

异步执行此操作。

DS_REPMOD_WRITEABLE

指示可以写入要修改的副本 (replica) 。

返回值

如果函数成功，则返回值 ERROR_SUCCESS。

如果函数失败，则返回值可以是以下值之一。

注解

注意

ntdsapi.h 标头将 DsReplicaModify 定义为别名，该别名根据 UNICODE 预处理器常量的定义自动选择此函数的 ANSI 或 Unicode 版本。将非特定编码别名的使用与非非特定编码的代码混合使用可能会导致不匹配，从而导致编译或运行时错误。有关详细信息，请参阅函数原型的约定。

要求

要求	值
最低受支持的客户端	Windows Vista
最低受支持的服务器	Windows Server 2008
目标平台	Windows
标头	ntdsapi.h
Library	Ntdsapi.lib
DLL	Ntdsapi.dll