IOleComponentUIManager.OnUIEventProgress – metoda (UInt32, Int32, String, UInt32, UInt32)

Článek
08/05/2016

Požadavky na zobrazení indikátoru průběhu během dlouhodobé operace.

Obor názvů: Microsoft.VisualStudio.Shell.Interop
Sestavení: Microsoft.VisualStudio.Shell.Interop (v Microsoft.VisualStudio.Shell.Interop.dll)

Syntaxe

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

Parametry

pdwCookie
[v] Určuje indikátor průběhu.Nastavení pdwCookie nula znamená, že SOleComponentUIManager služba by měla začít nový ukazatel průběhu.Pokud pdwCookie není nastavena na nulu, služba měla zobrazit aktuální ukazatel průběhu.

fInProgress
[v] Nastavit na true spustit nebo pokračovat v zobrazení indikátoru průběhu a false zrušíte zobrazení průběhu.

pwszLabel
[v] Body na popisek, který vysvětluje účel ukazatel průběhu.Pokud pswzLabel je nastavena na hodnotu null na následné aktualizace průběhu ukazatele průběhu probíhajících volání se používá předchozí hodnotu popisku.

nComplete
[v] Určuje čas, který již prošel operace.

nTotal
[v] Určuje celkovou dobu trvání operace.

Vrácená hodnota

Type: System.Int32

Pokud metoda uspěje, vrací S_OK.Pokud se nezdaří, vrátí kód chyby.

Poznámky

Podpis COM

Z oleipc.idl:

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

Chcete-li začít nový ukazatel průběhu volání objektu VSPackage OnUIEventProgress, nastavení pdwCookie na hodnotu null a fInProgress na hodnotu TRUE.SOleComponentUIManager Služba vrátí hodnotu k identifikaci konkrétního průběhu.Objekt VSPackage musí tuto hodnotu použít na všech následných výzev k aktualizaci stavu indikátor průběhu.Volání objektu VSPackage OnUIEventProgress s fInProgress nastavena na false ukazatel průběhu přerušit.

SOleComponentUIManager Služba řídí, zda může být více ukazatelů průběhu současně spuštěn.Obvykle pdwCookie je 1 označíte, že pouze jeden průběh indikátor vždy povolena.

Viz také

IOleComponentUIManager – rozhraní
Microsoft.VisualStudio.Shell.Interop – obor názvů

Zpátky na začátek

Sdílet prostřednictvím