FIN() Function - File Information BBj


For this topic's original documentation, see the FIN() Function - File Information.

BBj-Specific Information

VKEYED or XKEYED File FIN() Data

Bytes

Contents

65,12

$00$'s

77,4

Number of active keys in the file.

81,4

$00$'s

85,1

Default KNUM value.

86

Key definition data.

Key Definition Data

The key definition information is 48 8-byte entries using the following fields for each of the 48 entries:

Bytes

Contents

1,1

Key number or $FF$ for the end of definitions.

2,1

Field in record to use, or $00$ for no fielding.

3,2

Offset in field/record (0 based, 1024 maximum).

5,1

Length of this segment.

6,1

Segment modification bits:
$01$ - Descending segment
$02$ - Unique flag
$04$ - Business math flag
$08$ - Ordered numeric flag
$10$ - In BBj 12.0 and higher, case insensitive flag

7,2

$0000$

Following the last segment definition, the next key segment description key number must contain an $FF$ to indicate the end of the next segment list.

FULLTEXT File FIN() Data

The default IND=0 FIN() data is just the default for non-device FIN() data. With IND=1 the FIN() returns the template and id field specified when the file was created using the template "template:c(1*=0),keyfield:c(1*=0)".

SYSWINDOW Device FIN() Data

IND=2

In BBj 4.0 and higher, BBj returns the following with a SYSWINDOW channel and IND=2. Obtain the template itself with TMPL(chan,IND=2) on the same channel.

FIN(syswindow_chan,IND=2)

Note: The names of up to 50 fixed width fonts that are available to the SysWindow are listed by this template.

Value

Meaning

font_width:u(1) 

Width of the SYSWINDOW’s current font in pixels.

font_height:u(1)

Height of the SYSWINDOW’s current font in pixels.

font_name0:c(1*)

Name of a fixed-width font available to the SYSWINDOW.

font_name1:c(1*)

Name of a fixed-width font available to the SYSWINDOW.

font_name2:c(1*)

Name of a fixed-width font available to the SYSWINDOW.

...


font_name47:c(1*)

Name of a fixed-width font available to the SYSWINDOW.

font_name48:c(1*)

Name of a fixed-width font available to the SYSWINDOW.

font_name49:c(1*)

Name of a fixed-width font available to the SYSWINDOW.

 

IND=3

In BBj 4.0 and higher, BBj returns the following with a SYSWINDOW channel and IND=3. Obtain the template itself with TMPL(chan,IND=3) on the same channel.

FIN(syswindow_chan,IND=3)

Value

Meaning

term_x:i(2) 

Pixel location of upper left corner of the SYSWINDOW frame, relative to the screen.

term_y:i(2)

Pixel location of upper left corner of the SYSWINDOW frame, relative to the screen.

term_width:u(2) 

Pixel width of the SYSWINDOW frame.

term_height:u(2)

Pixel height of the SYSWINDOW frame.

 

IND=4

In BBj 4.0 and higher, BBj returns the following with a SYSWINDOW channel and IND=4. Obtain the template itself with TMPL(chan,IND=4) on the same channel.

FIN(syswindow_chan,IND=4)

Value

Meaning

top_width:u(2) 

Pixel width of the SYSWINDOW frame's top border and title bar.

left_width:u(2)

Pixel width of the SYSWINDOW frame's left border.

right_width:u(2) 

Pixel width of the SYSWINDOW frame's right border.

bottom_width:u(2)

Pixel width of the SYSWINDOW frame's bottom border.

menu_height:u(2)

Pixel width of the SYSWINDOW frame's menu bar.

 

IND=5

In BBj 14.0 and higher, BBj returns the following with a SYSWINDOW channel and IND=5. Obtain the template itself with TMPL(chan,IND=5) on the same channel.

FIN(syswindow_chan,IND=5)

Value

Meaning

point_size:u(1) 

Point size of the SYSWINDOW’s current font.

style:u(1)

Style of the SYSWINDOW’s current font, where 0 = Plain, 1 = Bold, 2 = Italic, and 3 = Bold Italic.

font_name:c(1*)

Name of the SYSWINDOW’s current font.

 

See Also

Functions - Alphabetical Listing



______________________________________________________________________________________

Copyright BASIS International Ltd. BBj®, Visual PRO/5®, PRO/5®, and BBx® are registered trademarks.