Int 2F Fn 80FB - Faxbios Interface - Command Submission [F]
AX = 80FBh
BX = function number (see #2616)
DX:DI -> command buffer
(see #2618,#2621,#2622,#2623,#2624,#2625,#2630,#2636,#2643)
Return: AL = FFh if submitted OK
CX = result code (see #2617)
Range: AH=80h to AH=FFh, selected by scanning multiplex numbers for signature
See Also: AX=8000h"FaxBIOS",AX=CBDDh
(Table 2616)
Values for FaxBIOS function number:
0001h SYS_LOGIN
0002h SYS_LOGOUT
0003h SYS_GET_FAXAPP_INFO
0004h STAT_IO_GET
0005h STAT_FAXBIOS_GET
0006h PDIR_OPEN
0007h PDIR_CLOSE (see #2626)
0008h PDIR_READ_PERSON (see #2627)
0009h PDIR_PARTIAL_READ
000Ah PDIR_READ_GROUP
000Bh PDIR_READ_MEMBER_LIST
000Ch PDIR_WRITE_PERSON
000Dh PDIR_WRITE_GROUP
000Eh PDIR_DELETE_PERSON
000Fh PDIR_DELETE_GROUP
0010h PDIR_READ_GROUP_LIST
0011h PDIR_IN_GROUP
0012h PDIR_OUT_GROUP
0013h SCHED_OPEN (see #2628)
0014h SCHED_ADD_DEST (see #2629)
0015h SCHED_ADD_FILE (see #2630)
0016h SCHED_SET_PARAMS (see #2631)
0017h SCHED_CANCEL (see #2628)
0018h SCHED_CLOSE (see #2632)
0019h SLOG_OPEN (see #2633)
001Ah SLOG_CLOSE (see #2633)
001Bh SLOG_SHORT_ENV_STAT
001Ch SLOG_LONG_ENV_STAT
001Dh SLOG_DEST_STAT
001Eh SLOG_FILE_STAT
001Fh SLOG_CANCEL_ENV
0020h RLOG_OPEN (see #2633)
0021h RLOG_CLOSE (see #2633)
0022h RLOG_READ
0023h GRAPH_GET_FILE_TYPE (see #2634)
0024h GRAPH_EXPORT_FILE
0025h GRAPH_GET_LAYOUT_INFO
0026h GRAPH_CREATE_FILE (see #2635)
0027h GRAPH_CLOSE_FILE (see #2636)
0028h GRAPH_CREATE_PAGE (see #2637)
0029h GRAPH_WRITE (see #2638)
002Ah GRAPH_END_PAGE
002Bh GRAPH_OPEN_FILE (see #2639)
002Ch GRAPH_GOTO_PAGE (see #2640)
002Dh GRAPH_READ (see #2641)
002Eh IOCTL_GET
002Fh IOCTL_SET
0030h IOCTL_ANSWER_FAX (see #2642)
0031h IOCTL_DIAL (see #2643)
(Table 2617)
Values for FaxBIOS result code:
0000h successful
0001h not prepared or servicing another client (busy)
0002h call failed due to sharing (LOCKED)
0003h logged-in client limit reached (FULL)
0004h transport denied (TRANSPORT_DENIED)
0005h not implemented (NOT_IMPLEMENTED)
0006h aborted while in progress (ABORTED)
0007h permissions denied (PERMISSION_DENIED)
0008h requested data is no longer valid (NO_LONGER_VALID)
0080h unspecified system error occurred
0081h an internal file was not found
0082h an internal file could not be created
0083h an internal file could not be opened
0084h an internal file could not be closed
0085h error occurred writing to an internal file
0086h error occurred reading from an internal file
0087h bad or corrupted file encountered
0088h an access violation occurred
0089h an internal file is empty
008Ah insufficient memory to process request
008Bh FaxBIOS was unable to issue a handle
008Ch an error internal to FaxBIOS occurred
008Dh no room on disk
0100h unspecified error accessing client file
0101h file not found
0102h creation fault
0103h open fault
0104h close fault
0105h write fault
0106h read fault
0107h file corrupted
0108h access violation
0109h empty file
0200h unspecified argument error
0201h bad function
0202h bad option
0203h bad structure size
0204h bad buffer size
0205h bad client ID
0300h unspecified error with token
0301h cover sheet token was invalid
0302h logo token was invalid
0303h signature token was invalid
0304h font token was invalid
0305h phone directory token was invalid
0306h outbound route token was invalid
0307h priority token was invalid
0308h sort token was invalid
0309h billing token was invalid
0400h unspecified handle error
0401h bad Phone Directory handle
0402h bad scheduling handle
0403h bad read send log handle
0404h bad read receive log handle
0405h bad graphics handle
0500h data passed in structure was invalid
0501h name field given is invalid
0502h phone number given is invalid
0503h poll code submitted is invalid
0504h file type constant was invalid
0505h BFT constant not defined or supported
0506h resolution not defined or supported
0507h page length not defined or supported
0508h page width not defined or supported
0509h date & time requested are ridiculous
050Ah Subject text was not an ASCIZ string
050Bh From text was not an ASCIZ string
050Ch requested envelope ID was not found
050Dh requested envelope ID is not valid
050Eh envelope requested was not found
050Fh destination index is out of range
0510h file index is out of range
0511h index into receive log is out of range
0512h file name specified was incomplete or invalid
0513h page selected was out of range
0514h bit width more than byte width
0515h mode for open is not defined
0516h person index is out of range
0517h person ID is out of range
0518h group index out of range or invalid
0519h group ID out of range or invalid
051Ah range of indices to read is invalid
051Bh group name given is invalid
051Ch field_to_use is badly specified
051Dh predicate invalid for field specified
0600h unspecified client procedure error
0601h device of interest is not present
0602h device of interest has been removed
0603h device of interest is not responding
0604h device of interest is disabled
0605h could not dial because device was in use
0606h maximum destination limit exceeded
0607h maximum file limit exceeded
0608h scheduling closed with no destination
0609h scheduling closed with no files or poll
060Ah scheduling closed with no parameters specified
060Bh file type specified does not match file
060Ch file type specified is not supported
060Dh file submitted is not exportable
060Eh file type specified is not imageable
060Fh error converting file
0610h envelope could not be cancelled
0611h Phone Directory is full
0612h record is already in the Phone Directory
0613h selected group in Phone Directory is full
0614h person is already in the group
0615h person is not in the group & cannot be removed
0616h a graphics file to be created already exists
0617h a graphics file to be read is empty
0618h GRAPH_CREATE_PAGE called before GRAPH_END_PAGE
0619h graph read or write attempted without goto or create
061Ah graph page contains no data
061Bh Phone Directory is already open for this client
061Ch schedule log is already open for this client
061Dh receive log is aready open for this client
061Eh Phone Directory function requires write mode
0800h denied exclusive use of the API
Format of FaxBIOS SYS_LOGIN command buffer:
Offset Size Description (Table 2618)
00h WORD structure size
02h WORD function number
04h WORD return code
06h WORD client ID
08h WORD API Major Version
0Ah WORD API Minor Version
0Ch DWORD reserved for manufacturer's use
10h 22 BYTEs manufacturer's ID
26h WORD highest possible device number
28h WORD maximum destinations per envelope
2Ah WORD maximum files per envelope
2Ch WORD FaxBIOS capabilities (see #2619)
2Eh DWORD T.30 capabilities (see #2620)
32h WORD IPC handle
34h DWORD amount of memory needed to load
38h WORD scope (00h for public, nonzero for private)
3Ah 6 BYTEs future expansion
40h WORD structure size
Bitfields for FaxBIOS capabilities:
Bit(s) Description (Table 2619)
0 transmit supported
1 receive supported
2 IOCTL supported
3 IOCTL_DIAL supported
4 IOCTL_ANSWER_FAX supported
5 manual transmit supported
6 optional phone services supported
7 canonical phone objects
8 seam with next supported
Bitfields for T.30 capabilities:
Bit(s) Description (Table 2620)
0 low vertical resolution (minimum)
1 high vertical resolution
2 page width 107mm (4.21 in)
3 page width 151mm (5.91 in)
4 page width 215mm (8.46 in) (minimum)
5 page width 255mm (10.04 in)
6 page width 303mm (11.93 in)
7 unused
8 page length 297mm (11.69 in) (minimum)
9 page length 364mm (14.33 in)
10 page length 279mm (11 in)
11 page length unlimited
12 Group 4 resolution 300x300
13 Group 4 resolution 400x400
14 able to respond to poll from remote
15 able to poll remote
16 binary file transfer supported
Format of FaxBIOS SYS_LOGOUT command buffer:
Offset Size Description (Table 2621)
00h WORD structure size
02h WORD function number
04h WORD return code
06h WORD client ID
08h DWORD client tag (for client's internal use)
0Ch 6 BYTEs future expansion
12h WORD structure size
Format of FaxBIOS SYS_GET_FAXAPP_INFO command buffer:
Offset Size Description (Table 2622)
00h 12 BYTEs common data (see #2621)
0Ch 80 BYTEs FaxBIOS data
5Ch 80 BYTEs default cover
ACh 80 BYTEs default logo
FCh 80 BYTEs default signature
14Ch 80 BYTEs default font 10
19Ch 80 BYTEs default font 165
1ECh 80 BYTEs default user font
23Ch 80 BYTEs default Pdir
28Ch 80 BYTEs default sort
2DCh 10 BYTEs default bill
2E6h 10 BYTEs default route
2F0h 40 BYTEs default cover sheet form
318h 34 BYTEs valid dial characters
33Ah 6 BYTEs local country code
340h 6 BYTEs local city or area code
346h 6 BYTEs future expansion
34Ch WORD structure size
Format of FaxBIOS STAT_IO_GET command buffer:
Offset Size Description (Table 2623)
00h 12 BYTEs common data (see #2621)
0Ch WORD device number
0Eh WORD current activity
10h WORD number of rings (if ringing)
12h WORD number of fascimiles transmitted
14h WORD number of fascimiles received
16h WORD status of last transmission
18h WORD envelope number of last transmission
1Ah WORD index of last destination in envelope
1Ch WORD status of last reception
1Eh WORD current page (if session in progress)
20h 80 BYTEs current file
70h 104 BYTEs remote number
D8h 20 BYTEs last name
ECh 20 BYTEs first name
100h 32 BYTEs company name
120h 32 BYTEs notes
140h WORD current envelope ID (if sending)
142h WORD total pages in transmission (if sending)
144h 6 BYTEs future expansion
14h WORD structure size
Format of FaxBIOS STAT_FAXBIOS_GET command buffer:
Offset Size Description (Table 2624)
00h 12 BYTEs common data (see #2621)
0Ch WORD status ID
0Eh WORD currenty FaxBIOS function number
10h WORD current Client ID being serviced
12h WORD number of things to do
14h WORD number of them done
16h WORD number of pages to do (if any)
18h WORD number of them done
1Ah WORD number of files to do
1Ch WORD number of them done
1Eh 80 BYTEs current File
6Eh WORD 0 if all devices are idle
70h WORD number of fascimiles transmitted
72h WORD number of fascimiles received
74h WORD status of last transmission in system
76h WORD envelope ID of last transmission
78h WORD index of last destination in envelope
7Ah WORD status of last reception in system
7Ch DWORD time of next transmission
80h 6 BYTEs future expansion
86h WORD structure size
Format of FaxBIOS PDIR_OPEN command buffer:
Offset Size Description (Table 2625)
00h 12 BYTEs common data (see #2621)
0Ch 80 BYTEs Phone Directory token
5Ch 80 BYTEs sort order token
ACh WORD open Mode (0 = read, 1 = write)
AEh WORD Phone Directory handle
B0h WORD number of people
B2h WORD number of groups
B4h WORD bitmap of fields supported by partial read
B6h 6 BYTEs future expansion
BCh WORD structure size
Format of FaxBIOS PDIR_CLOSE command buffer:
Offset Size Description (Table 2626)
00h 12 BYTEs common data (see #2621)
0Ch WORD Phone Directory handle
0Eh 6 BYTEs future expansion
14h WORD structure size
Format of FaxBIOS PDIR_READ_PERSON command buffer:
Offset Size Description (Table 2627)
00h 12 BYTEs common data (see #2621)
0Ch WORD Phone Directory handle
0Eh WORD retrieve by index
10h WORD person ID or index
12h WORD how many groups person is in
14h WORD person ID
16h 20 BYTEs last name
.NG limit reached, continued in next section...