IVsGeneratorProgress.Progress(UInt32, UInt32) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.12.40391

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Sets an index that specifies how much of the generation has been completed.

public:
 int Progress(System::UInt32 nComplete, System::UInt32 nTotal);

public:
 int Progress(unsigned int nComplete, unsigned int nTotal);

int Progress(unsigned int nComplete, unsigned int nTotal);

public int Progress (uint nComplete, uint nTotal);

abstract member Progress : uint32 * uint32 -> int

Public Function Progress (nComplete As UInteger, nTotal As UInteger) As Integer

Parameters

nComplete: UInt32

[in] Index that specifies how much of the generation has been completed. This value can range from zero to nTotal..

nTotal: UInt32

[in] The maximum value for nComplete.

Returns

Int32

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

Remarks

COM Signature

From vsshell.idl:

HRESULT IVsGeneratorProgress::Progress(

[in] ULONG nComplete,

[in] ULONG nTotal

);

The percent of the generation that has been completed is calculated by the project system as (nComplete / nTotal) * 100.

The Visual Basic and Visual C# project systems do not display custom tool progress to the user. However, custom tools should still implement this method to take advantage of progress reporting that may be available in a future version of Visual Studio.

Applies to

Share via