Método IOleComponentUIManager.OnUIEventProgress (UInt32, Int32, String, UInt32, UInt32)

Artigo
08/03/2016

Publicado: abril de 2016

Solicita a exibição de um indicador de progresso durante uma operação de longo prazo.

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

Sintaxe

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

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

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

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

Parâmetros

pdwCookie
[in] Identifica um indicador de progresso.Definindo pdwCookie a zero indica que o SOleComponentUIManager service deve começar um novo indicador de progresso.Se pdwCookie não está definido como zero, o serviço deve exibir o indicador de progresso atual.

fInProgress
[in] Definido como true para iniciar ou continuar a exibição de um indicador de progresso e false para cancelar a exibição do progresso.

pwszLabel
[in] Aponta para o rótulo que explica a finalidade do indicador de progresso.Se pswzLabel é definido como nulo em chamadas subseqüentes para atualizar o progresso de um indicador de andamento contínuo, o valor anterior do rótulo é usado.

nComplete
[in] Especifica o tempo que já passou para a operação.

nTotal
[in] Especifica a duração total da operação.

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 oleipc.idl:

HRESULT IOleComponentUIManager::OnUIEventProgress(
   [in][out] DWORD_PTR *pdwCookie,
   [in] BOOL fInProgress,
   [in] LPOLESTR pwszLabel,
   [in] ULONG nComplete,
   [in] ULONG nTotal
);

Para iniciar um novo indicador de progresso, um objeto VSPackage chama OnUIEventProgress, a configuração pdwCookie como nulo e fInProgress como TRUE.O SOleComponentUIManager serviço retorna um valor para identificar o indicador de progresso determinada.O objeto VSPackage deve usar esse valor em todas as chamadas subseqüentes para atualizar o estado de indicador de progresso.As chamadas do objeto VSPackage OnUIEventProgress com fInProgress definido como false para descontinuar o indicador de progresso.

O SOleComponentUIManager controla o serviço ou não vários indicadores de progresso podem ser executados simultaneamente.Normalmente pdwCookie está definido como 1 para indicar que se desenvolvem apenas um indicador ao mesmo tempo é permitido.

Consulte também

Interface IOleComponentUIManager
Namespace Microsoft.VisualStudio.Shell.Interop

Retornar ao topo

Partilhar via