<Connection variable>.RSDeleteConfig (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

Managing databases

Managing replications

WLanguage functions

Prefix syntax

RSDeleteConfig

Presentation

Example

See also

<Connection variable>.RSDeleteConfig (Function)

In french: <Variable Connexion>.RSSupprimeConfig

Available only with this kind of connection

Deletes a replication between two HFSQL servers. This function must be run on a replication's master HFSQL server, or on an orphaned subscriber server.

Example

MyConnection is Connection
...
MyConnection.RSDeleteConfig(ConfigReplication1)

Syntax

Deleting a replication identified by a hHRSConfig variable Hide the details

<Result> = <Connection>.RSDeleteConfig(<Replication to delete> [, <Type of deletion>])

<Result>: Boolean

True if the replication was deleted,
False otherwise. HErrorInfo is used to identify the error.

<Connection>: Connection variable

Name of the Connection variable that describes the connection to the HFSQL server on which the replication is performed.

<Replication to delete>: hRSConfig variable

Name of hRSConfig variable describing the replication to delete.

<Type of deletion>: Optional Integer constant

Type of replication to delete:
hrsDefault
(default value) Deletes the replication only if the subscriber server is accessible.
hrsIgnoreSubscriber Forces the deletion even if the other server cannot be contacted. In this case:
the information regarding the replication will not be deleted from the subscriber server.
for a bidirectional replication, the replication will not be deleted from the other server. We advise you to perform this deletion from this server as well to avoid a useless memory consumption.
hrsSubscriber Forces the deletion of an orphan replication on the subscriber side. In this case, the hRSConfig variable can be retrieved by <Connection variable>.RSListConfig associated with the hrsSubscriber constant.
Remark: Before version 190040, this parameter corresponded to a boolean (True equivalent to the hrsIgnoreSubscriber constant and False equivalent to the hrsDefault constant).

Deleting a replication identified by its identifier Hide the details

<Result> = <Connection>.RSDeleteConfig(<Identifier> [, <Forced deletion>])

<Result>: Boolean

True if the replication was deleted,
False otherwise. HErrorInfo is used to identify the error.

<Connection>: Connection variable

Name of the Connection variable that describes the connection to the HFSQL server on which the replication is performed.

<Identifier>: Integer

Identifier of replication to delete. This identifier corresponds to the Identifier property of the hRSConfig variable describing the replication.

<Forced deletion>: Optional boolean

True to force the deletion even if the other server cannot be contacted. In this case:
the information regarding the replication will not be deleted from the subscriber server.
for a bidirectional replication, the replication will not be deleted from the other server. We advise you to perform this deletion from this server as well to avoid a useless memory consumption. .
False (default value) to delete the replication only if the subscriber server is accessible.

Component: wd280hf.dll