DsReplicaAddA 函数 (ntdsapi.h)
DsReplicaAdd 函数将复制源引用添加到目标命名上下文。
语法
NTDSAPI DWORD DsReplicaAddA(
[in] HANDLE hDS,
[in] LPCSTR NameContext,
[in] LPCSTR SourceDsaDn,
[in] LPCSTR TransportDn,
[in] LPCSTR SourceDsaAddress,
[in] const PSCHEDULE pSchedule,
[in] DWORD Options
);
参数
[in] hDS
包含从 DSBind 或 DSBindWithCred 函数获取的目录服务句柄。
[in] NameContext
以 null 结尾的字符串,指定要为其添加副本 (replica) 的目标命名上下文 (NC) 的可分辨名称 (DN) 。 目标 NC 记录必须作为对象(实例化或不实例化)或引用虚拟(例如,具有 GUID 的虚拟)在本地存在。
[in] SourceDsaDn
以 null 结尾的字符串,指定源目录系统代理 NTDS-DSA 对象的 DN。 如果 Options 包含 DS_REPADD_ASYNCHRONOUS_REPLICA,则此参数是必需的;否则,将忽略它。
[in] TransportDn
以 null 结尾的字符串,指定表示用于与源服务器通信的 interSiteTransport 对象的 DN。 如果 Options 包含 DS_REPADD_INTERSITE_MESSAGING,则此参数是必需的;否则,将忽略它。
[in] SourceDsaAddress
以 null 结尾的字符串,指定源 DSA 的特定于传输的地址。 此源服务器由字符串名称标识,而不是由其 UUID 标识。 适用于 SourceDsaAddress 的 字符串名称通常是基于 GUID 的 DNS 名称,其中名称的 GUID 部分是源服务器的 NTDS-DSA 对象的 GUID 。
[in] pSchedule
指向 SCHEDULE 结构的指针,该结构包含复制源的复制计划数据。 此参数是可选的,如果未使用,可以为 NULL 。
[in] Options
传递用于处理请求的其他数据。 此参数可以是以下值的组合。
DS_REPADD_ASYNCHRONOUS_OPERATION
异步执行此操作。
DS_REPADD_ASYNCHRONOUS_REPLICA
不复制 NC。 请保存足够的状态数据,以便以后可以复制。
DS_REPADD_DISABLE_NOTIFICATION
禁用来自此源的 NC 的基于通知的同步。 这应为临时状态。 使用 DS_REPADD_NEVER_NOTIFY 永久禁用同步。
DS_REPADD_DISABLE_PERIODIC
禁用来自此源的 NC 的定期同步。
DS_REPADD_INITIAL
启动 DSA 时,从此源同步 NC。
DS_REPADD_INTERSITE_MESSAGING
使用站点间消息服务 (IMS) 传输(例如,通过 SMTP 而不是本机目录服务 RPC)从源 DSA 进行同步。
DS_REPADD_NEVER_NOTIFY
禁用来自此源的更改通知。 设置此标志后,源不会在发生更改时通知目标。 对于可能通过 WAN 链接进行的所有站点间复制,建议使用此方法。
这应为永久状态:使用 DS_REPADD_DISABLE_NOTIFICATION 暂时禁用通知。
DS_REPADD_PERIODIC
按照 pSchedule 中的定义,定期同步此源中的 NC。
DS_REPADD_USE_COMPRESSION
复制时使用压缩。 这可以节省网络带宽,但代价是源服务器和目标服务器的 CPU 开销。
DS_REPADD_WRITEABLE
创建可写副本 (replica) ;否则,副本 (replica) 为只读。
返回值
如果函数成功,则返回值 ERROR_SUCCESS。
如果函数失败,则返回值可以是以下值之一。
注解
注意
ntdsapi.h 标头将 DsReplicaAdd 定义为别名,该别名根据 UNICODE 预处理器常量的定义自动选择此函数的 ANSI 或 Unicode 版本。 将非特定编码别名的使用与非非特定编码的代码混合使用可能会导致不匹配,从而导致编译或运行时错误。 有关详细信息,请参阅 函数原型的约定。
要求
要求 | 值 |
---|---|
最低受支持的客户端 | Windows Vista |
最低受支持的服务器 | Windows Server 2008 |
目标平台 | Windows |
标头 | ntdsapi.h |
Library | Ntdsapi.lib |
DLL | Ntdsapi.dll |