Guardian Procedure Calls Reference Manual

Returned Value
INT
A file-system error code that indicates the outcome of the call.
Item Codes
Table 17 shows the item codes that can be specified when calling FILE_CREATELIST_.
NOTE: Items in this table with a size of 2 bytes are of data type INT. The term "disk file" applies
only to Enscribe files. The term "disk object" applies to Enscribe files and SQL objects.
Table 17 FILE_CREATELIST_ Item Codes
DescriptionSize
(Bytes)
Item
Code
File type. For disk objects other than SQL shorthand views, specifies the type of structure the file is
to have. This item must occur in the item list before other items whose meanings depend on the file
type. Valid values are:
241
unstructured0
relative1
entry-sequenced2
key-sequenced3
The default value is 0.
File code. For disk objects other than SQL shorthand views, an application-defined value associated
with the file. File codes 100 through 999 are reserved for use by HP. The default value is 0.
242
Logical record length. For structured disk objects, the maximum length of the logical record in bytes.
In H06.28/J06.17 RVUs with specific SPRs and later RVUs, the maximum record length for format
243
2 key-sequenced files is 27,648; for format 2 entry-sequenced files, the maximum record length is
4048; for format 2 relative files, the maximum record length is 4044. (For a list of the required
H06.28/J06.17 SPRs, see SPR Requirements for Increased Enscribe Limits for the H06.28/J06.17
Release (page 31).) For format 1 entry-sequenced and relative files, the maximum record length is
4072. If omitted, 80 is used. For queue files, this parameter must include 8 bytes for a timestamp.
This parameter is ignored for unstructured files. For more details, see the recordlen parameter
of FILE_CREATE_. Item 196 is an alternate form for this item.
Block length. For structured disk objects, the length in bytes of each block of records in the file. In
H06.28/J06.17 RVUs with specific SPRs and later RVUs, the maximum block length for format 2
244
key-sequenced files is 32,768; for format 1 or 2 entry-sequenced and relative files, the maximum
block length is 4096. (For a list of the required H06.28/J06.17 SPRs, see SPR Requirements for
Increased Enscribe Limits for the H06.28/J06.17 Release (page 31).) For earlier RVUs, the maximum
block length is 4096, regardless of the file organization or format. Data-block sizes are rounded
up to power-of-two multiples of the sector size: 512, 1024, 2048, 4096, or 32,768. For example,
if a 3K byte block were specified, the system would use 4096. For more details, see the blocklen
parameter of FILE_CREATE_. Item 197 is an alternate form for this item.
Key offset. For key-sequenced disk files, the number of bytes from the beginning of the record to
where the primary-key field starts. This item code applies only to Enscribe files. In H06.28/J06.17
245
RVUs with specific SPRs and later RVUs, the maximum key offset for format 2 key-sequenced files
is 27,647. (For a list of the required H06.28/J06.17 SPRs, see SPR Requirements for Increased
Enscribe Limits for the H06.28/J06.17 Release (page 31).) For earlier RVUs, the maximum key
offset is 4039 for format 2 files and 4061 for format 1 files. For queue files, the key offset must be
0. Either this item or item 198 is required for key-sequenced files.
Key length. For key-sequenced disk files, the length, in bytes, of the record's primary-key field. In
H06.28/J06.17 RVUs with specific SPRs and later RVUs, the maximum key length for format 2
246
key-sequenced files is 2048. (For a list of the required H06.28/J06.17 SPRs, see SPR Requirements
for Increased Enscribe Limits for the H06.28/J06.17 Release (page 31).) For earlier RVUs, the
maximum key length is 255, regardless of whether it is a format 1 or format 2 file.
394 Guardian Procedure Calls (F)