Udostępnij za pośrednictwem

Metoda IOleComponentUIManager.OnUIEventProgress — (UInt32, Int32, String, UInt32, UInt32)

  • Artykuł

 

Wyświetlanie wskaźnik postępu żądania podczas operacji długoterminowej.

Przestrzeń nazw:   Microsoft.VisualStudio.Shell.Interop
Zestaw:  Microsoft.VisualStudio.Shell.Interop (w Microsoft.VisualStudio.Shell.Interop.dll)

Składnia

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
    Type: System.UInt32

    [in] Identyfikuje wskaźnik postępu. Ustawianie pdwCookie na wartość zero oznacza, że SOleComponentUIManager usługa powinna być uruchamiana nowy wskaźnik postępu. Jeśli pdwCookie nie jest ustawiona na wartość 0, usługi powinien być wyświetlany bieżący wskaźnik postępu.

  • fInProgress
    Type: System.Int32

    [in] Ustaw true Aby rozpocząć lub kontynuować wyświetlanie wskaźnik postępu i false anulować wyświetlania postępu.

  • pwszLabel
    Type: System.String

    [in] Wskazuje na etykiecie objaśnienie jego przeznaczenia wskaźnik postępu. Jeśli pswzLabel ma wartość null w kolejnych wywołaniach zaktualizować postęp wskaźnik postępu w toku, zostanie użyta wartość poprzedniej etykiety.

  • nComplete
    Type: System.UInt32

    [in] Określa czas, który już został przekazany do działania.

  • nTotal
    Type: System.UInt32

    [in] Określa łączny czas trwania operacji.

Wartość zwracana

Type: System.Int32

Jeśli metoda zakończy się pomyślnie, zwraca S_OK. Jeśli nie, zwraca kod błędu.

Uwagi

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
);

Aby rozpocząć nowy wskaźnik postępu, wywołuje obiekt VSPackage OnUIEventProgress, ustawiając pdwCookie wartości null i fInProgress na wartość TRUE.SOleComponentUIManager Usługa zwraca wartość, aby zidentyfikować wskaźnik postępu określonego. Obiekt pakietu VSPackage, należy użyć tej wartości na wszystkich kolejnych wywołań do aktualizowania stanu wskaźnik postępu. Wywołania obiektu VSPackage OnUIEventProgress z fInProgress ustawić false przestać wskaźnik postępu.

SOleComponentUIManager Usługi określa, czy wiele wskaźniki postępu mogą działać jednocześnie. Zazwyczaj pdwCookie jest ustawiona na 1, aby wskazać, że tylko jeden postęp wskaźnika w czasie jest dozwolone.

Zobacz też

Interfejs IOleComponentUIManager
Przestrzeń nazw Microsoft.VisualStudio.Shell.Interop

Powrót do początku