InfoDok - obiekt predefiniowany - Język raportów Symfonia AM Basic

Jest to definicja obiektu zawierającego informację o dokumencie w buforze. Umożliwia odczyt i modyfikację istniejącego oraz dodanie nowego dokumentu w buforze.

Atrybuty

Typ	Nazwa	Opis
Int	bDok	Numer identyfikujący otwartą bazę dokumentów.
Int	bZap	Numer identyfikujący otwartą bazę zapisów. W przypadku pobierania dokumentów z bufora argument nie jest używany (bufor nie posiada odrębnej bazy zapisów).
Int	bRej	Numer identyfikujący otwartą bazę rejestrów.
Int	bKsie	Numer identyfikujący otwartą bazę dokumentów zaksięgowanych.
Int	bTrans	Numer identyfikujący otwartą bazę transakcji.
Int	bRozl	Numer identyfikujący otwartą bazę rozliczeń.

Metody

InfoDok.SetKey

Umożliwia ustawienie podanego jako argument klucza, według którego będzie pobrany rekord z bazy danych.

Składnia

Int SetKey (String nazwaK)

Argumenty

String

nazwaK

Tekstowa nazwa identyfikująca klucz.

InfoDok.SetKeySeg

Umożliwia ustawienie wartość segmentu bieżącego klucza w bazie dokumentów. Typ wartości nadawanej zależy od typu segmentu klucza. Patrz też polecenie SetKeySeg.

Składnia

Int SetKeySeg (String seg, wart)

Argumenty

String	seg	Tekstowa nazwa identyfikująca segment klucz.
	wart	Wartość, która zostanie nadana wskazanemu segmentowi. Typ wartości musi odpowiadać typowi segmentu klucza.

InfoDok.GetKeySeg

Umożliwia pobranie wartości segmentu bieżącego klucza w bazie dokumentów. Typ wartości zwracanej zależy od typu segmentu klucza. Patrz też polecenie GetKeySeg.

Składnia

GetKeySeg (String seg)

Argumenty

String

seg

Tekstowa nazwa identyfikująca segment klucz.

InfoDok.GetField

Umożliwia odczytanie wartość pola dokumentu. Typ wartości zwracanej zależy od typu pola. Rodzaj danej pobranej zależy od wartości argumentu id.

Składnia

GetField (Int id, String pole)

Argumenty

Int

Określenie rodzaju pobieranej wartości:

0 - pole dokumentu

1 - pole zapisu. Bieżący zapis musi być ustalony metodami Begin i Next

2 - pole rejestru. Bieżący rejestr musi być ustalony metodami Begin i Next

String

pole

Tekstowa nazwa identyfikująca pole.

InfoDok.SetField

Umożliwia nadanie wartości wybranemu polu dokumentu. Typ wartości nadawanej zależy od typu pola. Rodzaj danej nadawanej zależy od wartości argumentu id.

Składnia

Int SetField (Int id, String pole, wart)

Argumenty

Int

Określenie rodzaju pobieranej wartości:

0 - pole dokumentu

1 - pole zapisu. Bieżący zapis musi być ustalony metodami Begin, Next i Insert

2 - pole rejestru. Bieżący rejestr musi być ustalony metodami Begin, Next i Insert

String

pole

Tekstowa nazwa identyfikująca pole.

wart

Wartość, która zostanie nadana wskazanemu polu. Typ wartości musi odpowiadać typowi pola.

InfoDok.GetRec

Umożliwia wczytanie kompletnego dokumentu, według określonego wcześniej klucza w sposób określony przez argument.

Składnia

Int GetRec (operacja)

Argumenty

String

operacja

Zmienna symboliczna określająca sposób wczytania dokumentu. Szczegółowy opis dopuszczalnych wartości jak w poleceniu GetRec.

InfoDok.InsRec

Zapisuje nowy, kompletny dokument do bufora. Argument bDok obiektu musi wskazywać na otwartą bazę dokumentów w buforze. Tworzony jest zupełnie nowy dokument w buforze. Nie ma możliwości zapisu dokumentów do ksiąg. Przed zapisem dokumentu jest sprawdzana poprawność dokumentu i jest ustawiane pole errors w dokumencie.

Składnia

Int InsRec ( )

Argumenty

Brak.

InfoDok.DelRec

Kasuje (usuwa) uprzednio wczytany dokument w buforze. Argument bDok obiektu musi wskazywać na otwartą bazę dokumentów w buforze. Nie ma możliwości usuwania dokumentów w księgach.

Składnia

Int DelRec ( )

Argumenty

Brak.

InfoDok.Begin

Umożliwia ustawienie pierwszego zapisu lub rejestru w dokumencie. Dostęp do zapisów i rejestrów jest sekwencyjny, tzn. w danej chwili możliwy jest dostęp do jednego i tylko jednego zapisu i rejestru dokumentu.

Składnia

Int Begin (Int id)

Argumenty

Int

Określenie rodzaju ustawienia:

1 - ustawienie pierwszego zapisu w dokumencie

2 - ustawienie pierwszego rejestru w dokumencie

InfoDok.Next

Umożliwia ustawienie kolejnego zapisu lub rejestru w dokumencie. Dostęp do zapisów i rejestrów jest sekwencyjny, tzn. w danej chwili możliwy jest dostęp do jednego i tylko jednego zapisu i rejestru dokumentu.

Składnia

Int Next (Int id)

Argumenty

Int

Określenie rodzaju ustawienia:

1 - ustawienie kolejnego zapisu w dokumencie

2 - ustawienie kolejnego rejestru w dokumencie

InfoDok.Insert

Umożliwia dodanie nowego zapisu lub rejestru w dokumencie. W jednym dokumencie mogą być utworzone najwyżej trzy rejestry.

Składnia

Int Insert (Int id)

Argumenty