Product Documentation

User-Defined Extensions for Replication

Previous Topic

Next Topic

File Event Details

Open file

The Replication Agent is opening a replicated file on the target server.

VOID rxOnOpenFile(prxEVENT prxagentev);

Input Parameters: rxEVENT with rxFILOP (see Callback Function Input Parameters)

Output Parameters: rxEVENT action field:

  • RXA_DEFAULT - The Replication Agent opens the file on the target server.
  • RXA_SKIP - The Replication Agent does not open this file on the target server.
  • RXA_SHUTDOWN - The Replication Agent shuts down.

After file open

The Replication Agent has successfully opened a replicated file on the target server.

VOID rxAfterOpenFile(prxEVENT prxagentev);

Input Parameters: rxEVENT with rxFILOP (see Callback Function Input Parameters)

Output Parameters: rxEVENT action field:

  • RXA_DEFAULT - The Replication Agent continues normal operation.
  • RXA_SKIP - Returning this action for this event has no effect on the Replication Agent (same as RXA_DEFAULT).
  • RXA_SHUTDOWN - The Replication Agent shuts down.

Close file

The Replication Agent is closing a replicated file on the target server.

VOID rxOnCloseFile(prxEVENT prxagentev);

Input Parameters: rxEVENT with rxFILOP (see Callback Function Input Parameters)

Output Parameters: rxEVENT action field:

  • RXA_DEFAULT - The Replication Agent closes the file on the target server.
  • RXA_SKIP - The Replication Agent skips closing the file.
  • RXA_SHUTDOWN - The Replication Agent shuts down.

After Create IFile

The Replication Agent has successfully replicated a create file using an IFIL on the target server.

VOID rxAfterCREIFIL(prxEVENT prxagentev);

Input Parameters: rxEVENT with rxFILOP (see Callback Function Input Parameters)

Output Parameters: rxEVENT action field:

  • RXA_DEFAULT - The Replication Agent continues normal operation.
  • RXA_SKIP - Returning this action for this event has no effect on the Replication Agent (same as RXA_DEFAULT).
  • RXA_SHUTDOWN - The Replication Agent shuts down.

Alter schema

The Replication Agent is performing an alter schema operation on a replicated file the target server.

VOID rxOnAlterSchema(prxEVENT prxagentev);

Input Parameters: rxEVENT with rxFILOP (see Callback Function Input Parameters)

Output Parameters: rxEVENT action field:

  • RXA_DEFAULT - The Replication Agent performs the alter schema operation on the target data file.
  • RXA_SKIP - The Replication Agent skips the alter schema operation.
  • RXA_SHUTDOWN - The Replication Agent shuts down.

Resync file

The Replication Agent is resyncing a replicated file with the target server.

VOID rxOnResyncFile(prxEVENT prxagentev);

Input Parameters: rxEVENT with rxFILOP (see Callback Function Input Parameters)

Output Parameters: rxEVENT action field:

  • RXA_DEFAULT - The Replication Agent performs the resync file operation on the target data file.
  • RXA_SKIP - The Replication Agent skips the resync file operation.
  • RXA_SHUTDOWN - The Replication Agent shuts down.

TOCIndex