ScriptTransferPercentComplete Event

This feature will be removed in a future version of Microsoft SQL Server. Avoid using this feature in new development work, and plan to modify applications that currently use this feature.

The ScriptTransferPercentComplete event occurs after SQL Distributed Management Objects (SQL-DMO) completes Transact-SQL command batch generation for a Microsoft SQL Server component referenced by the Transfer object.

Syntax

Private Sub
object
_ScriptTransferPercentComplete(
Message as String
, 
Percent as Long
)

Parts

  • object
    Expression that evaluates to an object in the Applies To list.
  • Message
    String that contains descriptive message text.
  • Percent
    Long integer representation of a percentage value. The value is the percent of processing complete scaled by 100. For example, a process seven percent complete reports the value 7.

Prototype (C/C++)

HRESULT ScriptTransferPercentComplete(SQLDMO_LPCSTR szMessage,
long Percent);

Remarks

When using the ScriptTransfer method of the Database object, SQL-DMO calculates percentage completion as each component is scripted. The ScriptTransferPercentComplete event is raised once for every component referenced by the Transfer object.

Applies To:

Transfer Object