Guardian Procedure Calls Reference Manual

partonly

input

INT:value

if present, specifies for partitioned files whether the function is to be performed for all partitions

of the file (if the value is zero (0)), or just for the named partition (if the value is 1).

Nonpartitioned files use zero.

If omitted, zero (0) is assumed. A value of 1 cannot be specified for some functions, as

noted below. If a function would affect alternate-key files, then a value of 1 will prevent this.

Condition Code Settings

indicates that an error occurred (call FILEINFO or FILE_GETINFO_ ).< (CCL)

indicates that the call to ALTER was successful.= (CCE)

indicates that an error occurred (call FILEINFO or FILE_GETINFO_).> (CCG)

Function Codes

Table 4 lists the values that can be specified for the function parameter and describes the

characteristics of the files that these functions change.

Table 4 ALTER Function Codes

DescriptionCode

File-code: Change the application defined file code associated with the file. File codes 100-999 are reserved

for use by HP. The newvalue parameter is a one-word binary number.

Audited: Change the TMF audited characteristic of the file (file-type.<2> from FILEINFO or item 66

from FILE_GETINFOLIST[BYNAME]_ ). The newvalue parameter is a one-word binary number with a value

of 1 to make the file audited or a value of zero (0) to make it unaudited. Unless the value of partonly is

1, all alternate-key files as well as all partitions will be changed.

Refresh: Change the flag controlling whether the file’s EOF value is written out each time it is changed

(file-type.<10> from FILEINFO or item 70 from FILE_GETINFOLIST[BYNAME]_ ). The newvalue

parameter is a one-word binary number with a value of 1 to cause writing or zero (0) to avoid writing.

Oddunstr: For an unstructured file, make the file allow odd byte positioning and transfers (indicated by

file-type.<12> from FILEINFO or item 65 from FILE_GETINFOLIST[BYNAME]_ ). The newvalue parameter

must be a one-word binary number with value of 1. Once set for a file, this characteristic cannot be reset.

Alternate Keys: For a structured file, change the alternate key description. The newvalue parameter should

be an array in the same format as the alternate-key-params array of the CREATE procedure. This

function changes only the description in the primary file; no alternate-key files are purged or created. The

partonly parameter must be zero (0) for this function. This function is not supported for format 2 files.

Partitions: Change the partitioning description of the file. The newvalue parameter should be an array in

the same format as the partition-params array of the CREATE procedure. The partition description can

be changed only in these ways:

• The volume name of an existing partition may change.

• For a key-sequenced file, the extent sizes of a partition may be changed.

• For non-key-sequenced files, new partitions may be added. This function changes the description only

in the primary file; no secondary partitions are moved, updated, or created.

The partonly parameter must be zero (0) for this function. This function is not supported for format 2 files.

Broken Flag: Resets the broken flag (which is shown in open-flags2.<6> of FILEINFO or item 78 from

FILE_GETINFOLIST[BYNAME]_ ). The newvalue parameter must be a one-word binary number with a value

of zero (0). For a partitioned file, the partonly parameter must have a value of 1 for this function.

Expiration Date: Change the expiration date associated with the file to the one given in newvalue. The

newvalue parameter must be a four-word GMT timestamp.

ALTER Procedure (Superseded by FILE_ALTERLIST_ Procedure) 65