Dokumentacja pliku posnet.h

Idź do kodu źródłowego tego pliku.

Definicje

#define POSNET_API   __declspec(dllimport)
 Standardowy sposób obsługi bibliotek DLL.
#define POSNET_DEBUG_ALL   0xFFFFFFFF
 Rejestracja wszystkich informacji we wszystkich podsystemach.
#define POSNET_DEBUG_EXTRA   0x00800000
 Rejestracja szczegółowych informacji o stanach rozkazów.
#define POSNET_DEBUG_NONE   0x00000000
 Brak rejestrowania informacji.
#define POSNET_DEV_PARAM_COMSETTINGS   0x00020001
 Parametry portu szeregowego.
#define POSNET_DEV_PARAM_FILEHANDLE   0x0002000E
 Pobranie uchwytu portu szeregowego.
#define POSNET_DEV_PARAM_LISTUSBSERIALS   0x00020008
 Odczyt wszystkich numerów seryjnych drukarek podłączonych do komputera poprzez interfejs USB i sterownik FTDI - D2XX.
#define POSNET_DEV_PARAM_OUTQUEUELENGTH   0x00020009
 Długość kolejki wysyłkowej, po przekroczeniu, której rozkazy traktowane są jak wysyłane w trybie natychmiastowym.
#define POSNET_DEV_PARAM_SENDTIMEOUT   0x00020004
 Czas w [s] po jakim ma być zaniechane wysyłanie ramki.
#define POSNET_DEV_PARAM_STATUSPOLLINGINTERVAL   0x0002000A
 Interwał pomiędzy automatycznymi odpytaniami o status drukarki.
#define POSNET_DEV_PARAM_USBSERIAL   0x00020007
 Numer seryjny drukarki do otwarcia przez typ urządzenia POSNET_INTERFACE_USB.
#define POSNET_EVENT_CALLBACK   0x0004
 Tryb obsługi poprzez wywołanie funkcji w momencie otrzymania pakietu danych asynchronicznych.
#define POSNET_EVENT_DISABLE   0x0000
 Wyłączenie obsługi zdarzeń asynchronicznych - w tym trybie wszystkie zdarzenia są automatycznie usuwane, a aplikacja nie jest o nich informowana.
#define POSNET_EVENT_EVENT   0x0001
 Sygnalizacja otrzymania zdarzenia za pomocą komunikacji międzyprocesowej typu "Event" (zdarzenie) w systemie Windows. Po wybraniu tego typu obsługi za pomocą funkcji POS_GetEvent można uzyskać uchwyt zdarzenia zarezerwowanego przez urządzenie.
#define POSNET_EVENT_MESSAGE   0x0002
 Sygnalizacja otrzymania zdarzenia za pomocą komunikatów systemu Windows. Po wybraniu tego trybu należy za pomocą funkcji POS_SetMessageParams ustawić kod komunikatu i uchwyt okna do którego ma on być wysłany. Wysyłany komunikat ma jako lParam umieszczony uchwyt urządzenia, które go wygenerowało.
#define POSNET_INTERFACE_RS232   0x0001
 Podłączenie przez RS232.
#define POSNET_INTERFACE_USB   0x0002
 Podłączenie przez USB.
#define POSNET_NAMELENGTH_MAX   16
 Definicja minimalnego rozmianu bufora znakowego nazwy polecenia, nazwy parametru.
#define POSNET_REQMODE_AUTOCLEAR   0x03
 Ten tryb powoduje automatyczne czyszczenie odpowiedzi,.
#define POSNET_REQMODE_IMMEDIATE   0x01
 Tryb bezpośredni.
#define POSNET_REQMODE_SPOOL   0x00
 Tryb kolejkowania [domyślny], w tym trybie rozkaz umieszczany jest na.
#define POSNET_REQMODE_SPOOLSPECIAL   0x02
 Tryb kolejkowania specjalnego, w którym.
#define POSNET_RSTATE_COMPLETED   0x00019004
 Wykonanie rozkazu zakończone.
#define POSNET_RSTATE_ERRCOMPLETED   0x00019005
 Wykonanie rozkazu zakończone błędem.
#define POSNET_RSTATE_NEW   0x00019000
 Nowe polecenie, nie umieszczone w kolejce.
#define POSNET_RSTATE_PENDING   0x00019001
 Nowe polecenie, umieszczone w kolejce.
#define POSNET_RSTATE_SENT   0x00019002
 Polecenie wysłane, nie potwierdzone.
#define POSNET_STATUS_ALREADY_COMPLETED   0x00010000
 Rozkaz już wykonany.
#define POSNET_STATUS_BUFFERTOOSHORT   0x00010007
 Przekazany bufor znakowy jest za mały.
#define POSNET_STATUS_BUSY   0x00000020
 Urządzenie zajęte.
#define POSNET_STATUS_CANCELLED   0x0001000A
 Rozkaz anulowany.
#define POSNET_STATUS_CASHREGBASE   0x00430000
 Bazowy kod błędu wykonania rozkazu drukarki [błędy 0x00430000 - 0x0043FFFF].
#define POSNET_STATUS_CASHREGCOMMBASE   0x00440000
 Bazowy kod błędu transmisji rozkazu do drukarki [błędy 0x00440000 - 0x0044FFFF].
#define POSNET_STATUS_COMMERROR   0x00000008
 Błąd komunikacji.
#define POSNET_STATUS_COULDNOTOPEN   0x00000005
 Nie można otworzyc wskazanego urządzenia.
#define POSNET_STATUS_COULDNOTOPEN_ACCESSDENIED   0x0000000C
 Błąd otwarcia urządzenia - dostęp zabroniony.
#define POSNET_STATUS_COULDNOTOPEN_FILENOTFOUND   0x0000000D
 Błąd otwarcia urządzenia - brak takiego pliku (urządzenia).
#define POSNET_STATUS_COULDNOTSETUPPORT   0x0000000B
 Błąd ustawienia parametrów otwieranego portu.
#define POSNET_STATUS_CRCERROR   0x00000006
 Błąd CRC w odebranej ramce.
#define POSNET_STATUS_DEVICE_BUSY   0x00000014
 Urządzenie zajęte.
#define POSNET_STATUS_EMPTY   0x00010001
 Brak danych w kolejce.
#define POSNET_STATUS_FRAMETOOSHORT   0x00000002
 Za krótka ramka.
#define POSNET_STATUS_FRAMINGERROR   0x00000003
 Błąd ramki odebranej z drukarki.
#define POSNET_STATUS_FTLIBIMPORTFAIL   0x0000000A
 Nieudany import sterownika FTDI.
#define POSNET_STATUS_INVALID_PARAM1   0x00010101
 Błędny 1 parametr polecenia.
#define POSNET_STATUS_INVALID_PARAM2   0x00010102
 Błędny 2 parametr polecenia.
#define POSNET_STATUS_INVALID_PARAM3   0x00010103
 Błędny 3 parametr polecenia.
#define POSNET_STATUS_INVALID_PARAM4   0x00010104
 Błędny 4 parametr polecenia.
#define POSNET_STATUS_INVALID_PARAM5   0x00010105
 Błędny 5 parametr polecenia.
#define POSNET_STATUS_INVALID_PARAM6   0x00010106
 Błędny 6 parametr polecenia.
#define POSNET_STATUS_INVALIDCOMMAND   0x00010005
 Błędny numer polecenia.
#define POSNET_STATUS_INVALIDHANDLE   0x00010006
 Błędny uchwyt.
#define POSNET_STATUS_INVALIDSPOOLMODE   0x00010009
 Błędny tryb kolejkowania.
#define POSNET_STATUS_INVALIDSTATE   0x00000013
 Wydano polecenie REPEAT dla ramki znajdującej się w niewłaściwym stanie (innym niż SENT lub ACK).
#define POSNET_STATUS_INVALIDVALUE   0x00010002
 Błędna wartość.
#define POSNET_STATUS_IPCERROR   0x00000007
 Błąd utworzenia obiektu IPC (Event).
#define POSNET_STATUS_OK   0x00000000
 Brak błędu.
#define POSNET_STATUS_OUTOFMEMORY   0x00000001
 Brak pamięci.
#define POSNET_STATUS_OUTOFRANGE   0x00010008
 Poza zakresem licznika.
#define POSNET_STATUS_PENDING   0x00010004
 Polecenie w trakcie wykonywania.
#define POSNET_STATUS_SETUP_INVALIDBAUD   0x0000000E
 Błędne parametry portu - baudrate.
#define POSNET_STATUS_SETUP_INVALIDDATA   0x0000000F
 Błędne parametry portu - databits.
#define POSNET_STATUS_SETUP_INVALIDHANDSHAKE   0x00000012
 Błędne parametry portu - handshake.
#define POSNET_STATUS_SETUP_INVALIDPARITY   0x00000010
 Błędne parametry portu - parity.
#define POSNET_STATUS_SETUP_INVALIDSTOP   0x00000011
 Błędne parametry portu - stop bits.
#define POSNET_STATUS_TIMEOUT   0x00010003
 Oczekiwanie zakończone upłynięciem czasu (timeout).
#define POSNET_STATUS_USBERROR   0x00000009
 Błąd krytyczny USB - urządzenie nie będzie funkcjonować poprawnie.
#define POSNET_SUBSYSTEM_DEVICE   0x00001000
 Podsystem urządzenia.
#define POSNET_SUBSYSTEM_DEVICERS232   0x00002000
 Podsystem RS232.
#define POSNET_SUBSYSTEM_DEVICEUSB   0x00008000
 Podsystem USB (używa sterownika D2XX, w przypadku korzystania ze.
#define POSNET_SUBSYSTEM_FRAME   0x00010000
 Podsystem ramki - wyświetla zawartość wysyłanych i odbieranych ramek.

Definicje typów

typedef void( POSNET_CALLBACK_T )(unsigned long status)
 Typ definiujący funkcję callback dla zdarzeń asynchronicznych. Przyjmuje jeden parametr

  • złożony status urządzenia (w/g wzoru: (Status urządzenia * 65536)+status mechanizmu ) .

typedef void * POSNET_HANDLE
 Definicja typu uchwytu urządzenia.
typedef unsigned long POSNET_STATE
 Definicja typu wartości zwracanej jako stan rozkazu.
typedef unsigned long POSNET_STATUS
 Definicja typu wartości zwracanej jako status.

Funkcje

POSNET_API POSNET_STATUS __stdcall POS_CancelRequest (POSNET_HANDLE hRequest)
 Anulowanie obiektu rozkazowego.
POSNET_API POSNET_STATUS __stdcall POS_CloseDevice (POSNET_HANDLE hLocalDevice)
 Zamknij urządzenie.
POSNET_API POSNET_HANDLE __stdcall POS_CreateDeviceHandle (unsigned long deviceType)
 Utworzenie uchwytu do nowego urządzenia.
POSNET_API POSNET_HANDLE __stdcall POS_CreateRequest (POSNET_HANDLE hLocalDevice, const char *command)
 Funkcja tworzy nowy obiekt rozkazowy dla drukarki.
POSNET_API POSNET_HANDLE __stdcall POS_CreateRequestEx (POSNET_HANDLE hLocalDevice, const char *command, const char *parameters)
 Funkcja tworzy nowy obiekt rozkazowy dla drukarki oraz dodaje parametry rozkazu.
POSNET_API POSNET_STATUS __stdcall POS_DestroyDeviceHandle (POSNET_HANDLE hGlobalDevice)
 Usuń istniejący uchwyt urządzenia i zwolnij zajmowaną pamięć.
POSNET_API POSNET_STATUS __stdcall POS_DestroyRequest (POSNET_HANDLE hRequest)
 Zniszczenie obiektu rozkazowego i zwolnienie zajmowanej przezeń pamięci.
POSNET_API POSNET_STATUS __stdcall POS_GetDeviceParam (POSNET_HANDLE hDevice, unsigned long paramCode, void *paramValue)
 Funkcja do pobierania parametrów urządzenia.
POSNET_API POSNET_STATUS __stdcall POS_GetError (POSNET_HANDLE hLocalDevice)
 Podaj kod statusu związany z uchwytem urządzenia.
POSNET_API const char *__stdcall POS_GetErrorString (POSNET_STATUS code, char *lang)
 Zwróć tekstowy opis błędu.
POSNET_API HANDLE __stdcall POS_GetEvent (POSNET_HANDLE hLocalDevice)
 Funkcja zwraca uchwyt do zdarzenia. Obiekt zdarzenia jest zarządzany przez bibliotekę. Zdarzenie pracuje w trybie Manual Reset patrz.
POSNET_API unsigned long __stdcall POS_GetLibraryVersion ()
 Pobierz wersję biblioteki.
POSNET_API POSNET_HANDLE __stdcall POS_GetNextResponse (POSNET_HANDLE hLocalDevice)
 Pobierz z kolejki odpowiedzi (rozkazów zakończonych) następny dostępny wynik.
POSNET_API POSNET_STATUS __stdcall POS_GetPrnDeviceStatus (POSNET_HANDLE hLocalDevice, const char statusMode, long *globalStatus, long *printerStatus)
 Pobranie statusu drukarki. Drukarka jest periodycznie odpytywana o status i rezultat tej operacji jest przechowywany. Funkcja jest blokująca jeśli wykonywane jest odpytywanie.
POSNET_API unsigned long __stdcall POS_GetRequestAge (POSNET_HANDLE hRequest)
 Wiek rozkazu - czas jaki upłynął od wywołania POS_PostRequest.
POSNET_API POSNET_STATUS __stdcall POS_GetRequestCommandID (POSNET_HANDLE hRequest, char *retCommand)
 Pobierz numer polecenia, który został użyty przy tworzeniu obiektu.
POSNET_API unsigned long __stdcall POS_GetRequestCommandSerial (POSNET_HANDLE hRequest)
 Pobierz numer seryjny rozkazu.
POSNET_API unsigned long __stdcall POS_GetRequestCount (POSNET_HANDLE hLocalDevice, unsigned char globalnie=0)
 Pobierz ilość rozkazów oczekujących w kolejce rozkazów wysłanych przez bieżący kontekst urządzenia lub wszystkich rozkazów oczekujących w kolejce.
POSNET_API POSNET_STATE __stdcall POS_GetRequestState (POSNET_HANDLE hRequest)
 Zwróć stan rozkazu.
POSNET_API POSNET_STATUS __stdcall POS_GetRequestStatus (POSNET_HANDLE hRequest)
 Zwróć status rozkazu.
POSNET_API unsigned long __stdcall POS_GetResponseCount (POSNET_HANDLE hLocalDevice)
 Pobierz ilość wyników w kolejce wyników.
POSNET_API POSNET_STATUS __stdcall POS_GetResponseValue (POSNET_HANDLE hRequest, const char *paramName, char *retVal, unsigned long retValLen)
 Pobierz watość parametru po nazwie.
POSNET_API long __stdcall POS_GetResponseValueCount (POSNET_HANDLE hRequest)
 Pobierz ilość otrzymanych pól wartości.
POSNET_API POSNET_HANDLE __stdcall POS_OpenDevice (POSNET_HANDLE hGlobalDevice)
 Otwórz urządzenie.
POSNET_API POSNET_STATUS __stdcall POS_PopResponseValue (POSNET_HANDLE hRequest, char *retName, char *retVal, unsigned long retValLen)
 Pobierz wartość parametru i przesuń na następne pole.
POSNET_API POSNET_STATUS __stdcall POS_PostRequest (POSNET_HANDLE hRequest, unsigned char mode)
 Fukcja umieszcza obiekt rozkazowy w kolejce rozkazów do wykonania.
POSNET_API POSNET_STATUS __stdcall POS_PushRequestParam (POSNET_HANDLE hRequest, const char *param_name, const char *param_value)
 Wstaw parametr rozkazu.
POSNET_API POSNET_STATUS __stdcall POS_RepeatRequest (POSNET_HANDLE hRequest)
 Wysyła do drukarki żądanie powtórzenia transmisji odpowiedzi.
POSNET_API POSNET_HANDLE __stdcall POS_RequestDevice (POSNET_HANDLE hRequest)
 Funkcja służy do pobrania uchwytu urządzenia związanego z rozkazem.
POSNET_API POSNET_STATUS __stdcall POS_RequestQueueCancelAll (POSNET_HANDLE hLocalDevice, unsigned char globalnie=0)
 Wyczyść kolejkę rozkazów oczekujących na wykonanie (zarówno wysłanych jak i oczekujących na wysłanie).
POSNET_API POSNET_STATUS __stdcall POS_RequestQueueCancelPending (POSNET_HANDLE hLocalDevice, unsigned char globalnie=0)
 Wyczyść kolejkę rozkazów oczekujących na wysłanie (nie ignoruj odpowiedzi na rozkazy już wysłane).
POSNET_API POSNET_STATUS __stdcall POS_RequestQueueStats (POSNET_HANDLE hLocalDevice, unsigned long *sent, unsigned long *completed)
 Pobierz statystyki kolejek. Statystyki są zwracane w kontekście całego urządzenia.
POSNET_API POSNET_STATUS __stdcall POS_ResponseRewind (POSNET_HANDLE hRequest)
 Przesuń wskaźnik pól na początek listy.
POSNET_API POSNET_STATUS __stdcall POS_SetCallback (POSNET_HANDLE hLocalDevice, POSNET_CALLBACK_T *callback)
 Funkcja ustawia w bibliotece funkcję callback, która będzie wywoływana po otrzymaniu zdarzenia asynchronicznego.
POSNET_API void __stdcall POS_SetDebugFileName (POSNET_HANDLE hGlobalDevice, const char *fileName)
 Ustawienie nazwy pliku śledzącego.
POSNET_API void __stdcall POS_SetDebugLevel (POSNET_HANDLE hGlobalDevice, unsigned long debugLevel)
 Ustaw poziom informacyjności biblioteki.
POSNET_API POSNET_STATUS __stdcall POS_SetDeviceParam (POSNET_HANDLE hDevice, unsigned long paramCode, void *paramValue)
 Funkcja do ustawiania parametrów urządzenia.
POSNET_API POSNET_STATUS __stdcall POS_SetEventHandlingMode (POSNET_HANDLE hLocalDevice, unsigned long eventMode)
 Ustaw metodę obsługi zdarzeń asynchronicznych.
POSNET_API POSNET_STATUS __stdcall POS_SetMessageParams (POSNET_HANDLE hLocalDevice, UINT messageCode, HANDLE hWnd)
 Funkcja ustawia kod komunikatu i uchwyt okna do którego ma być on wysłany przy obsłudze zdarzeń asynchronicznych. Tylko dla Windows. Jako lParam takiego komunikatu wysyłany jest złożony status urządzenia (w/g wzoru: (Status urządzenia * 65536)+status mechanizmu ).
POSNET_API POSNET_STATUS __stdcall POS_WaitForRequestCompleted (POSNET_HANDLE hRequest, unsigned long timeout)
 Czekaj na zakończenie rozkazu.

Wygenerowano Fri Jan 1 17:47:20 2010 dla POSNET COMBO DF LIBRARY programem  doxygen 1.6.1