Share via

SharedStatusBar.Progress Method (SharedStatusBarOwner, Int32, String, UInt32, UInt32, Boolean)

  • Article

Shows the progress of operations that take a determinate amount of time.

Namespace:  Microsoft.VisualStudio.Data.Schema.Package.UI
Assembly:  Microsoft.VisualStudio.Data.Schema.Package (in Microsoft.VisualStudio.Data.Schema.Package.dll)

Syntax

'Declaration
Public Function Progress ( _
    possibleOwner As SharedStatusBarOwner, _
    fInProgress As Integer, _
    pwszLabel As String, _
    nComplete As UInteger, _
    nTotal As UInteger, _
    ignoreOwner As Boolean _
) As Integer

public int Progress(
    SharedStatusBarOwner possibleOwner,
    int fInProgress,
    string pwszLabel,
    uint nComplete,
    uint nTotal,
    bool ignoreOwner
)

public:
virtual int Progress(
    SharedStatusBarOwner^ possibleOwner, 
    int fInProgress, 
    String^ pwszLabel, 
    unsigned int nComplete, 
    unsigned int nTotal, 
    bool ignoreOwner
) sealed

abstract Progress : 
        possibleOwner:SharedStatusBarOwner * 
        fInProgress:int * 
        pwszLabel:string * 
        nComplete:uint32 * 
        nTotal:uint32 * 
        ignoreOwner:bool -> int 
override Progress : 
        possibleOwner:SharedStatusBarOwner * 
        fInProgress:int * 
        pwszLabel:string * 
        nComplete:uint32 * 
        nTotal:uint32 * 
        ignoreOwner:bool -> int 

public final function Progress(
    possibleOwner : SharedStatusBarOwner, 
    fInProgress : int, 
    pwszLabel : String, 
    nComplete : uint, 
    nTotal : uint, 
    ignoreOwner : boolean
) : int

Parameters

  • fInProgress
    Type: System.Int32
    true while the progress bar is being used; false when it has completed.
  • pwszLabel
    Type: System.String
    Text to display in the status field while the progress bar is being used.
  • nComplete
    Type: System.UInt32
    Number of units currently completed in the progress bar.
  • nTotal
    Type: System.UInt32
    Total number of units for the progress bar operation.
  • ignoreOwner
    Type: System.Boolean
    Indicates whether to ignore the owner of the status bar.

Return Value

Type: System.Int32

Implements

ISharedStatusBar.Progress(SharedStatusBarOwner, Int32, String, UInt32, UInt32, Boolean)

.NET Framework Security

See Also

Reference

SharedStatusBar Class

Progress Overload

Microsoft.VisualStudio.Data.Schema.Package.UI Namespace