Método IVsStatusbar.Progress (UInt32, Int32, String, UInt32, UInt32)

Artigo
08/03/2016

Publicado: abril de 2016

Mostra o progresso das operações que levam a um determinado período de tempo.

Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop (em Microsoft.VisualStudio.Shell.Interop.dll)

Sintaxe

int Progress(
    ref uint pdwCookie,
    int fInProgress,
    string pwszLabel,
    uint nComplete,
    uint nTotal
)

int Progress(
    unsigned int% pdwCookie,
    int fInProgress,
    String^ pwszLabel,
    unsigned int nComplete,
    unsigned int nTotal
)

abstract Progress : 
        pdwCookie:uint32 byref *
        fInProgress:int *
        pwszLabel:string *
        nComplete:uint32 *
        nTotal:uint32 -> int

Function Progress (
    ByRef pdwCookie As UInteger,
    fInProgress As Integer,
    pwszLabel As String,
    nComplete As UInteger,
    nTotal As UInteger
) As Integer

Parâmetros

pdwCookie
[in, out] ID do usuário atual, para evitar que várias usa da barra de progresso, ao mesmo tempo.

fInProgress
[in] true enquanto a barra de progresso está em uso; false quando concluída.

pwszLabel
[in] Texto a ser exibido no campo status, enquanto a barra de progresso está em uso.

nComplete
[in] Número de unidades atualmente concluir na barra de progresso.

nTotal
[in] Número total de unidades para a operação de barra de progresso.

Valor de retorno

Type: System.Int32

Se o método for bem-sucedido, ele retorna S_OK.Se ele falhar, ele retorna um código de erro.

Comentários

COM assinatura

De vsshell.idl:

HRESULT IVsStatusbar::Progress(
   [in,out]VSCOOKIE *pdwCookie,
   [in]BOOL fInProgress,
   [in]LPCOLESTR pwszLabel,
   [in]ULONG nComplete,
   [in]ULONG nTotal
);

Progresso é exibido como uma barra azul crescente na área da barra de progresso da barra de status.Na primeira vez que um usuário da barra de status chama esse método, pdwCookie deve ser definido como zero.O valor retornado, em seguida, em pdwCookie é a identificação exclusiva que esse usuário da barra de status deve usar em futuras chamadas desse método.

Esse método é chamado para exibir a quantidade de progresso que estão sendo feita durante uma operação.Como tal, nTotal deve ser conhecida antes de chamar esse método.Se nTotal não pode ser determinada antecipadamente e a operação deve demorar mais do que alguns segundos, a chamada a Animation método em vez disso.

Consulte também

Interface IVsStatusbar
Namespace Microsoft.VisualStudio.Shell.Interop

Retornar ao topo

Compartilhar via