Code

UniVerse Notes

UNIVERSE.INCLUDE

UniData Notes

0

1 if file.variable

is a valid file variable; 0 otherw

FINFO$IS.FILEVAR

File open status

1= Open

0= Not open

1

VOC name of the file

FINFO$VOCNA

This parameter is not

implemented.

2

Path name of the file On Windows, a file that is local to the account will

be delimited with a forward slash

FINFO$PATHNA

Path name of file

3

File type as follows:

1 Static hashed

3 Dynamic hashed

4 Type 1

5 Sequential

7 Distributed and Multivolu

FINFO$TYP

File Type

HASHED      2

DYNAMIC     3

DIRECTORY   4

SEQUENTIAL  5

NFA         7

OS          8

EDA        13

4

Hashing algorithm: 2 for GENERAL, 3 for NUM

FINFO$HASHALG

Hash Type

HASH & DYNAMIC(KEYONLY) Hash type (0, 1, or 3)

DYNAMIC (KEYDATA) Hash type (32 , 33, or 35)

DYNAMIC (WHOLEFILE) Hash type (48, 49, or 51)

5

Current modulus.

FINFO$MODULUS

Hash             Modulo

Directory        0

Dynamic          Current modulo

Other            Not applicable

6

Minimum modulus

FINFO$MINMODULUS

Dynamic – Min Modulus

7

Group size, in 1-KB units.

FINFO$GROUPSIZE

Hash/Dynamic (Block size/1024)-1

Other     Not applicable

8

Large record size.

FINFO$LARGERECORDSIZE

8

Hash & Dynamic      Blocksize

Others                       Not applicable

9

Merge load parameter.

FINFO$MERGELOAD

Merge factor percentage

10

Split load parameter.

FINFO$SPLITLOAD

Split factor percentage

11

Current loading of the file (%).

FINFO$CURRENTLOAD

Current load percentage

Percent result of the

formula:

(keyspace(grp)*100)/blksize

12

Empty string, if the file resides on the local system,

otherwise the name of the node where the file resides

FINFO$NODENAME

Node name

This parameter is not

implemented.

13

1 if secondary indexes exist on the file; 0 otherwise

FINFO$IS.AKFILE

Does file contain alternate key

indexes?

1= yes; 2 = no

14

Current line number.

FINFO$CURRENTLINE

Next line number to read or write

Sequential Files: Next line number

15

For a distributed file, returns list of currently open part

numbers.

FINFO$PARTNUM

Part number

This parameter is not

implemented.

16

For a distributed file, returns list of status codes showing

whether the last I/O operation succeeded or failed for

each part. A value of –1 indicates the corresponding part

file is not open.

FINFO$STATUS

This parameter is not

implemented.

17

Returns 1 for all recoverable file types: static, dynamic, B-

tree, and distributed files. Returns 0 for non-recoverable

file types: DIR and sequential files.

FINFO$RECOVERYTYPE

17

Filename

HASH & DIR & DYNAMIC - VOC entry name

18

Always returns an empty string

FINFO$RECOVERYID

18

Block size of file  (Returns the same value as

option 8)

19

Always returns 0

FINFO$IS.FIXED.MODULUS

19

Access permissions

Permissions the person

running the program has

expressed as total

UNIX

values

(r=4,w=2,x=1, so rw= 6)

20

If NLS is enabled, the file map name, otherwise an empty

string. If the map name is the default specified in the

uvconfig

file, the returned string is the map name

followed by the name of the configurable parameter in

parentheses.

FINFO$NLSMAP

20

Index to which the last SETINDEX

statement was applied (VOC entry name )

21

( Note documented )

FINFO$MAXKEYSIZE

21

Index record read by last

browsing statement, such as

READFWD and READBCK.

(Key value)

22

Returns a dynamic array containing the following

information:

▪

For a file encrypted with the WHOLERECORD option:

-1@VM<key_id>@VM<algorithm>

▪

For a file encrypted at the field level:

<location>@VM<key_id>@VM

<algorithm>@VM<field_name>[@FM

<location>...@VM<field_name>]

▪

Returns an empty string if the file is not encrypted

FINFO$ENCINFO

22

File type: recoverable or

Nonrecoverable

1 – Recoverable

0 – Nonrecoverable

23

Returns a dynamic array containing the following

information:

▪

For an encrypted index field:

<location>@VM<key_id>@VM<algorithm>

@VM<field_name>[@FM<location>...@VM<field_name>]

▪

Note that multiple encrypted index fields are

separated by

@FM

.

▪

Returns an empty string if the field is not encrypted

or CREATE.INDEX

<file> <field>

has not been

issued.

FINFO$IDXENCINFO

23

Numeric key

For sequentially hashed

files.

1 – Numeric keys

0 – Non-numeric keys

24

Return values can be:

0 – The file is not published, subscribed, or subwriteable.

1 – The file is being published.

2 – The file is being subscribed.

3 – The file is subwriteable.

Note

:

If

Data Replication

is not running, 0 is returned for

any file used with this function.

FINFO$REPSTATUS

Type of U2 Data Replication file

0 - The file is not a replication    object

1 – The file is being published

2 – The file is being subscribed

3 - The file is subwriteable

24

Return values can be:

0 - The dynamic file contains no records.

1 - The dynamic file contains records

FINFO$MAXOPTION

25

BEFORE-UPDATE-TRIGGER catalog program name of the file <xx>.

BEFORE-UPDATE-TRIGGER

catalog program name of

the file. If no such trigger

exists, returns and empty

string.

26

BEFORE-DELETE-TRIGGER catalog program name of the file <xx>.

BEFORE-DELETE-TRIGGER

catalog program name of

the file. If no such trigger

exists, returns and empty

string.

27

Is the file encrypted?

0 – File is not encrypted

1 – File is encrypted

28

Type of file encryption

Returns a dynamic array

containing the following

information:

For a file encrypted with

the WHOLERECORD option:

-1@SM<key-

id>@SM<algorithm>

For a file encrypted at the

field level:

<location>@SM<key-

id>@SM<algorithm>

@SM<field_name>

Returns an empty string if

the file is not encrypted.

29

AFTER-UPDATE-TRIGGER catalog

program name of the file <xx>.

AFTER-UPDATE-TRIGGER

catalog program name of

the file. If no such trigger

exists, returns an empty

string.

30

AFTER-DELETE-TRIGGER catalog

program name of the file <xx>.

AFTER-DELETE-TRIGGER

catalog program name of

the file. If no such trigger

exists, returns an empty

string.

31

Defines the bit type

0 – 32–bit file

1 – 64–bit fil

99

Special key to retrieve hdr layout

FINFO$HDRLAYOUT