• Article

PublicationMonitor.TransPendingCommandInfo Method

Returns information about pending commands for a subscription.

Namespace:  Microsoft.SqlServer.Replication
Assembly:  Microsoft.SqlServer.Rmo (in Microsoft.SqlServer.Rmo.dll)

Syntax

'Declaration
Public Function TransPendingCommandInfo ( _
    subscriberName As String, _
    subscriptionDBName As String, _
    subscriptionType As SubscriptionOption _
) As PendingCommandInfo
'Usage
Dim instance As PublicationMonitor
Dim subscriberName As String
Dim subscriptionDBName As String
Dim subscriptionType As SubscriptionOption
Dim returnValue As PendingCommandInfo

returnValue = instance.TransPendingCommandInfo(subscriberName, _
    subscriptionDBName, subscriptionType)

public PendingCommandInfo TransPendingCommandInfo(
    string subscriberName,
    string subscriptionDBName,
    SubscriptionOption subscriptionType
)

public:
PendingCommandInfo^ TransPendingCommandInfo(
    String^ subscriberName, 
    String^ subscriptionDBName, 
    SubscriptionOption subscriptionType
)

member TransPendingCommandInfo : 
        subscriberName:string * 
        subscriptionDBName:string * 
        subscriptionType:SubscriptionOption -> PendingCommandInfo 

public function TransPendingCommandInfo(
    subscriberName : String, 
    subscriptionDBName : String, 
    subscriptionType : SubscriptionOption
) : PendingCommandInfo

Parameters

  • subscriberName
    Type: System.String
    A String value that specifies the name of the Subscriber on which the subscription resides.
  • subscriptionDBName
    Type: System.String
    A String value that specifies the name of the subscription database.

Return Value

Type: Microsoft.SqlServer.Replication.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).

The TransPendingCommandInfo method is available with SQL Server 2005 only.

This namespace, class, or member is supported only in version 2.0 of the .NET Framework.