IVsCommonMessagePump.SetProgressInfo Method

Specifies the progress information for the wait dialog.

Namespace:  Microsoft.VisualStudio.Shell.Interop
Assemblies:   Microsoft.VisualStudio.Shell.Interop.10.0 (in Microsoft.VisualStudio.Shell.Interop.10.0.dll)
  Microsoft.VisualStudio.Shell.12.0 (in Microsoft.VisualStudio.Shell.12.0.dll)

Syntax

'Declaration
Function SetProgressInfo ( _
    iTotalSteps As Integer, _
    iCurrentStep As Integer, _
    pszProgressText As String _
) As Integer

int SetProgressInfo(
    int iTotalSteps,
    int iCurrentStep,
    string pszProgressText
)

int SetProgressInfo(
    [InAttribute] int iTotalSteps, 
    [InAttribute] int iCurrentStep, 
    [InAttribute] String^ pszProgressText
)

abstract SetProgressInfo : 
        iTotalSteps:int * 
        iCurrentStep:int * 
        pszProgressText:string -> int

function SetProgressInfo(
    iTotalSteps : int, 
    iCurrentStep : int, 
    pszProgressText : String
) : int

Parameters

• iTotalSteps
  Type: Int32

  The total number of steps.

• iCurrentStep
  Type: Int32

  The current step (must be between 1 and iTotalSteps).

• pszProgressText
  Type: String

  The text for the progress information

Return Value

Type: Int32
If the method succeeds, it returns S_OK. If it fails, it returns an error code.

.NET Framework Security

• Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

See Also

Reference

IVsCommonMessagePump Interface

Microsoft.VisualStudio.Shell.Interop Namespace