Instrukcja obsługi R2płatnik

procedure BeginProgress(StartRec,RecCount:integer; Caption,Descr:PChar);stdcall;

Pokazuje na ekranie i rozpoczyna pasek postępu

Parametry

• StartRec - minimalna liczba rekordów, dla których będzie pokazany pasek postępu; jeśli liczba wszystkich rekordów RecCount będzie mniejsza, pokaże się tylko klepsydra.

• RecCount - liczba wszystkich rekordów (kroków) dla jakich zostanie wykonany pasek postępu

• Caption - tytuł paska postępu

• Descr - opis wykonywanej operacji paska postępu

Zwracane wartości

Brak

Uwagi

Po wywołaniu tej funkcji, do aplikacji podstawowej zostanie przekazana wiadomość, aby uruchomiła pasek postępu z odpowiednimi parametrami. Następnie aplikacja API może sterować postępem paska za pomocą funkcji GoProgress tak długo, ile kroków ma do wykonania. Aby ukryć pasek, aplikacja API powinna wywołać EndProgress.

procedure BeginProgressWithBreak(StartRec,RecCount:integer; Caption,Descr:PChar);stdcall;

Pokazuje na ekranie i rozpoczyna pasek postępu z możliwością przerwania operacji

Parametry

• StartRec - minimalna liczba rekordów, dla których będzie pokazany pasek postępu; jeśli liczba wszystkich rekordów RecCount będzie mniejsza, pokaże się tylko klepsydra.

• RecCount - liczba wszystkich rekordów (kroków) dla jakich zostanie wykonany pasek postępu

• Caption - tytuł paska postępu

• Descr - opis wykonywanej operacji paska postępu

Zwracane wartości

Brak

Uwagi

Po wywołaniu tej funkcji, do aplikacji podstawowej zostanie przekazana wiadomość, aby uruchomiła pasek postępu z odpowiednimi parametrami. Następnie aplikacja API może sterować postępem paska za pomocą funkcji GoProgress tak długo, ile kroków ma do wykonania. Aby ukryć pasek, aplikacja API powinna wywołać EndProgress.

procedure GoProgress(Descr:PChar);stdcall;

Wykonuje kolejny krok paska postępu

Parametry

• Descr - opis operacji dla kolejnego kroku postępu (zostanie on pokazany w opisie paska)

Zwracane wartości

Brak

Uwagi

Brak

procedure GoProgressWithBreak(Descr:PChar);stdcall;

Wykonuje kolejny krok paska postępu z możliwością przerwania operacji

Parametry

• Descr - opis operacji dla kolejnego kroku postępu (zostanie on pokazany w opisie paska)

Zwracane wartości

Brak

Uwagi

Jeśli operacja zostanie przerwana, zostanie wysłana do API wiadomość o numerze 12

procedure EndProgress;stdcall;

Kończy i ukrywa pasek postępu

Parametry

Brak

Zwracane wartości

Brak

Uwagi

Brak

procedure MessageBox(Ide:integer;Caption:PChar);stdcall;

Pokazuje okno informacyjne z informacją, ostrzeżeniem lub błędem

Parametry

• Ide - rodzaj okna informacyjnego:

  • 1 - informacja
  • 2 - ostrzeżenie
  • 3 - błąd

• Caption -opis pokazany w oknie informacyjnym

Zwracane wartości

Brak

Uwagi

Brak

function ConfirmBox(Caption:PChar; Param:integer):integer;stdcall;

Pokazuje okno informacyjne z pytaniem

Parametry

• Caption - pytanie w oknie

• Param - opcje okna z pytaniem, bitowo:

  • 0x1 - widoczny przycisk "Nie"
  • 0x2 - widoczny przycisk "Anuluj"
  • 0x100 - domyślny przycisk "Nie"
  • 0x200 - domyślny przycisk "Anuluj"

Zwracane wartości

• 6 - naciśnięto przycisk "Tak"
• 7 - naciśnięto przycisk "Nie"
• 2 - naciśnięto przycisk "Anuluj"

Uwagi

Jeśli chcemy, aby były widoczne wszystkie trzy przyciski (przycisk "Tak" jest zawsze widoczny), a przycisk "Anuluj" był domyślny, w parametrze Param należy wpisać 0x1 + 0x2 + 0x200

procedure PrintHtm(Ide:integer;URL:PChar);stdcall;

Wywołuje okno z przeglądarką wydruków

Parametry

• Ide - unikalny numer wydruku

• URL - nazwa pliku (z pełną ścieżką) zawierającego wydruk w formacie HTML

Zwracane wartości

Brak

Uwagi

Numer wydruku powinien być unikalny. Aby nie kolidował z wydrukami istniejącymi w aplikacji podstawowej, powinien być większy od 30000.

procedure AddonIsWorking;stdcall;

Daje znać aplikacji podstawowej, że API zostało uruchomione

Parametry

Brak

Zwracane wartości

Brak

Uwagi

Jeśli chcemy, aby addon uruchomił się razem z aplikacją podstawową, w pliku rplatnik.ini w sekcji [Addon] należy wpisać:
AllMachines=ścieżka do naszej aplikacji API, jeśli ścieżka jest wspólna dla wszystkich maszyn
lub
Nazwa_komputera=ścieżka do naszej aplikacji API, jeśli ścieżka jest unikalna dla każdej maszyny
przykładowo:
[Addon]
AllMachines=C:\RESET2\Platnik.10x\DEMOS\Delphi\Przykład 2\R2platnikUI.exe
Aplikacja API powinna wywołać tę procedurę, aby zapobiegać ponownemu wywołaniu API w sytuacji, gdy aplikacja główna nie zamknęła poprawnie API.