9.154 PHYSICAL_KEY

Note: Built-In Function Rules     Usage Options

Specifies or re-specifies the name of a field that is a key of the physical file associated with the file definition being edited.

An edit session must be commenced using the START_FILE_EDIT Built-In Function prior to using PHYSICAL_KEY.

Warning: This Built-In Function cannot be used for a file of type "OTHER".

This is a Specialized Built-In Function for use in a Development Environment only.

Arguments

No

Type

Req/ Opt

Description

Min Len

Max Len

Min Dec

Max Dec

1

A

Req

Name of key field. Must have been previously specified as a field in the file by using the FILE_FIELD Built-In Function.

1

10

 

 

2

N

Opt

Optional sequencing number. Used to sequence key fields. If not specified keys are sequenced in the same order as they are presented.

1

5

0

0

 

Return Values

No

Type

Req/ Opt

Description

Min Len

Max Len

Min Dec

Max Dec

1

A

Req

Return code

OK = key defined

ER = fatal error detected

In case of "ER" return code error message(s) are issued automatically and the edit session ended without commitment.

2

2