Share via

PublicationMonitor.TransPendingCommandInfo Method

  • Article

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

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

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

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

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

Parameters

  • subscriberName
    A String value that specifies the name of the Subscriber on which the subscription resides.
  • subscriptionDBName
    A String value that specifies the name of the subscription database.
  • subscriptionType
    A SubscriptionOption object value that specifies the type of subscription (push or pull).

Return Value

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.

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

See Also

Reference

PublicationMonitor Class
PublicationMonitor Members
Microsoft.SqlServer.Replication Namespace

Other Resources

How to: Programmatically Monitor Replication (RMO Programming)