Share via


CReplicationServer Class

Administers Commerce Server Staging (CSS) servers.

Methods

Method

Description

AddEventSink

Creates or opens an event sink.

Dd451951.alert_note(en-US,CS.90).gifNote:
This method supports CSS but should not be used directly from your code. It is for Microsoft internal use only.

AddRoute

Adds a route to the CSS routing table.

CheckAccess

Retrieves the current user's CSS rights on the server.

Commit

Commits changes that have been made to a property that is defined for the CSS service.

Continue

Starts the CSS service after the server has been paused.

DeleteEventSink

Removes an event sink for the CSS service on the server.

Dd451951.alert_note(en-US,CS.90).gifNote:
This method supports CSS but should not be used directly from your code. It is for Microsoft internal use only.

DeleteProject

Deletes a project from the server.

DeleteRoute

Deletes a route from the CSS routing table for the server.

Enum

Retrieves the global properties that are assigned to the CSS service on the server.

EnumEventSinks

Retrieves the event sinks defined for the CSS service on the server.

Dd451951.alert_note(en-US,CS.90).gifNote:
This method supports CSS but should not be used directly from your code. It is for Microsoft internal use only.

EnumProjects

Retrieves the projects defined on the server.

EnumReplications

Retrieves the replications that are running on the CSS server.

EnumRoutes

Retrieves the replication routes that are defined on the CSS server.

EnumServers

Retrieves the names of servers that are defined for a project or for a route on the CSS server.

EventTimeToLocalTime

Converts a date-time value to the local time zone value.

Get

Retrieves a global property that is defined on the server.

Initialize

Initializes a CReplicationServer object on the CSS server.

InitializeEx

Initializes a CReplicationServer object on the CSS server by using a different user context and an optional time-out value.

MapUrl

Maps a URL to a project.

Dd451951.alert_note(en-US,CS.90).gifNote:
This method supports CSS but should not be used directly from your code. It is for Microsoft internal use only.

OpenProject

Opens an existing CSS project or creates a new project.

Pause

Pauses the CSS service on the server.

Put

Sets a global property for the CSS service on the server.

Start

Starts the CSS service on the server.

Stop

Stops the CSS service on the server.

TranslateEventCode

Retrieves the description, severity, and category for the specified event code.

Properties

Property

Description

ServerName

Gets the name of the CSS server.

UseTransactions

Gets a value that specifies whether the server has transaction processing enabled.

Version

Gets the version number of the CSS service that is running on the server.

Remarks

You can create a new CReplicationServer object by calling the OpenProject method.

After you gain access to the CReplicationServer object, you must call its Initialize or InitializeEx method to initialize the object before you can call its other methods or access its properties.

The following table provides additional information about the CReplicationServer class.

Assembly

CSSAPILib

Namespace

Microsoft.CommerceServer.Staging.Interop

Dd451951.alert_note(en-US,CS.90).gifNote:
You must also add a using directive for the System.ServiceProcesses namespace.

Corresponding COM class

ReplicationServer

CLSID

7E95698D-CD3C-4C98-93C7-6510C31F7DDF

ProgID

CssApi.ReplicationServer

Example

The following example opens the project named Project2.

CReplicationServer replicationServer = new CReplicationServer();
  replicationServer.Initialize("");
  CReplicationProject replicationProject = (CReplicationProject)replicationServer.OpenProject("Project2", CSS_PROJECT_CREATION.OPEN_EXISTING_PROJECT);

See Also

Other Resources

Commerce Server Staging Reference

Before You Start Developing with the Commerce Server Staging System

What are the Staging API Concepts?

Projects

Managing the CSS Service

How to Set, Modify, and Retrieve Global Properties for a CSS Service

How to Pause, Continue, Start, and Stop the CSS Service

How to Retrieve Staging Information

CReplicationClient Class

Commerce Server Staging Reference