PublicationMonitor.TransPendingCommandInfo Method

Reference

Definition

Namespace:: Microsoft.SqlServer.Replication

Assembly:: Microsoft.SqlServer.Rmo.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Returns information about pending commands for a subscription.

public:
 Microsoft::SqlServer::Replication::PendingCommandInfo ^ TransPendingCommandInfo(System::String ^ subscriberName, System::String ^ subscriptionDBName, Microsoft::SqlServer::Replication::SubscriptionOption subscriptionType);

public Microsoft.SqlServer.Replication.PendingCommandInfo TransPendingCommandInfo (string subscriberName, string subscriptionDBName, Microsoft.SqlServer.Replication.SubscriptionOption subscriptionType);

member this.TransPendingCommandInfo : string * string * Microsoft.SqlServer.Replication.SubscriptionOption -> Microsoft.SqlServer.Replication.PendingCommandInfo

Public Function TransPendingCommandInfo (subscriberName As String, subscriptionDBName As String, subscriptionType As SubscriptionOption) As PendingCommandInfo

Parameters

subscriberName: String

A String value that specifies the name of the Subscriber on which the subscription resides.

subscriptionDBName: String

A String value that specifies the name of the subscription database.

subscriptionType: SubscriptionOption

A SubscriptionOption object value that specifies the type of subscription (push or pull).

Returns

PendingCommandInfo

A PendingCommandInfo object value that contains the list of pending commands and estimated time to complete delivering them.

Remarks

The TransPendingCommandInfo method can only be called by members of the sysadmin fixed server role on the Distributor, by members of the db_owner fixed database role on the distribution database, or by users in the publication access list (PAL) for the publication.

Calling TransPendingCommandInfo is equivalent to executing sp_replmonitorsubscriptionpendingcmds (Transact-SQL).

Applies to

Share via