HPlogo 900 Series HP 3000 Computer Systems: MPE/iX Architected Interface Facility: Operating System Reference Manual > Chapter 3 Architected Interface Descriptions

AIFFILEGGET/PUT Items

» 

Technical documentation

Complete book in PDF
» Feedback

 » Table of Contents

 » Index

The following two tables provide summary and detailed descriptions of the item numbers associated with global file information.

Item Summary

The following table summarizes the item numbers associated with global file information. For more detailed information about these item numbers, refer to the table of global file item descriptions.

Table 3-11 Global File Information Item Summary

ItemTypeDescriptionPutVerMinMaxError#
5001Filename_typeMPE File nameNY   
5002UFID_typeUFIDNY   
5003CA16Creator nameYY   
5004Longint_typeCreate timestampYY   
5005Longint_typeL A timestampYY   
5006Longint_typeL M timestampYY   
5007Longint_typeF A timestampYY   
5008I32File codeYY   
5009U32File accessYY   
5010CA8File lockwordYY   
5011I32UnusedNN   
5012I32FoptionsNY   
5013I32Privileged levelNY   
5014BReleasedYY   
5015BTemporaryNY   
5016U32Record sizeNY   
5017U32End of file (EOF)NY   
5018U32File limitNY   
5019I32# user labelsNY   
5020I32User label limitNY   
5021U32Block sizeNY   
5022I32Blocking factorNY   
5023CA34Volume restrictionNY   
5024I32Message file openNY   
5025I32# of usersNY   
5026I32# of readersNY   
5027I32# of writesNY   
5028I32# record pointersNY   
5029I32Close dispositionYY050
5030I32Virtual addressNY   
5031U32World accessYY   
5032U32Group accessYY   
5033U32Group librarian accessYY   
5034U32Account accessYY   
5035U32Account librarian accessYY  
5036pathname_typePathnameNY   
5037path_identifierPath IdentifierNY   
5038U32Running Link CountNY   
5039U32File typeNY   
5040U32Record typeNY   
5041CA36File Owner YY   
5042BACD RequiredNY   
5043CA16File GroupNY   
5044logint_typeState Change TimestampYY   
5045BUpdate State Change TimestampYN   
5046U32Current Link CountNY   
5047I32Number of ExtentsNN   
5048I32Number of SectorsNN   
5051BFollow Symbolic LinkNN   

 

Item Descriptions

The following table provides detailed descriptions of item numbers and corresponding items associated with global file information.

Table 3-12 Global File Information Item Descriptions

Item NumberItem Name (Data Type) Put; Verify; Release Available\ Description
5001

MPE File Name (REC) Put: No; Verify: Yes; Release 3.0

Returns the fully qualified file name in the record format defined by filename_type. The file name, group name, and account name are each left-justified and padded with blanks. Note that this item should only be used for names that can be expressed using MPE-only semantics (for example, NL.PUB.SYS). Item 5036 should be used for HFS syntax or MPE syntax files that will be represented using an HFS pathname (for example, /SYS/PUB/pxdir/pxfile). If you specify this item for an HFS syntax file, blanks and a warning are returned in itemstatus_array.

Record type: filename_type (Refer to appendix B.)

5002

UFID (REC) Put: No; Verify: Yes; Release 3.0

Returns the UFID associated with a file name in the record format defined by ufid_type.

Record type: ufid_type (Refer to appendix B.)

5003

Creator Name (CA16) Put: Yes; Verify: Yes; Release 3.0

Returns or modifies the name of the user who created the file. It is assumed that the account name of the file and the creator are the same. This should be a legal MPE/iX user name that is left-justified and padded with blanks.

Note that with the introduction of the hierarchical file system, the creator concept has been replaced with the concept of the file owner. The creator name item is maintained for backward compatibility, but in the future, you should use item 5041 to obtain or modify the full file owner name (user and account).

5004

Creation Timestamp (REC) Put: Yes; Verify: Yes; Release 3.0

Returns or modifies the number of microseconds from January 1, 1970 to the time that the file was created.

Record type: longint_type (Refer to appendix B.)

5005

Last Access Timestamp (REC) Put: Yes; Verify: Yes; Release 3.0

Returns or modifies the number of microseconds from January 1, 1970 to the time that the file was last accessed.

Record type: longint_type (Refer to appendix B.)

5006

Last Modify Timestamp (REC) Put: Yes; Verify: Yes; Release 3.0

Returns or modifies the number of microseconds from January 1, 1970 to the time that the file was last modified.

Record type: longint_type (Refer to appendix B.)

5007

File Allocation Timestamp (REC) Put: Yes; Verify: Yes; Release 3.0

Returns or modifies the number of microseconds from January 1, 1970 to the time that the file was allocated.

Record type: longint_type (Refer to appendix B.)

5008

File Code (I32) Put: Yes; Verify: Yes; Release 3.0

Returns or modifies the file code of the file. A negative number indicates that the file is privileged.

5009

Creator Access Rights (U32) Put: Yes; Verify: Yes; Release 3.0

Returns or modifies the file creator access rights. Bits and their meanings are:

Bits (0:24)

Unused

Bit (24:1)

Read

Bit (25:1)

Write

Bit (26:1)

Execute

Bit (27:1)

Append

Bit (28:1)

Lock

Bit (29:1)

Save

Bit (30:1)

Update

Bit (31:1)

Dir_read

5010

File Lockword (CA8) Put: Yes; Verify: Yes; Release 3.0

Returns or modifies the lockword of the file. This should be a legal MPE/iX lockword, left-justified and padded with blanks. If a file does not have a lockword, blanks are returned.

You cannot use this item for files outside MPE groups since files in HFS directories cannot have lockwords. POSIX does not recognize the concept of lockwords, and they cannot be specified using POSIX syntax.

5012

Foptions (I32) Put: No; Verify: Yes; Release 3.0

Returns the file characteristics in the form of an foptions bit mask. The bits and their meanings are

Bits ( 0:18)

Unused

Bits (18:3)

File type

Bit (21:1)

File equations

Bit (22:1)

Labeled tape

Bit (23:1)

Carriage control

Bits (24:2)

Record type

Bits (26:3)

File designator

Bit (29:1)

ASCII/binary

Bits (30:2)

File domain

5013

Privileged Level (I32) Put: No; Verify: Yes; Release 3.0

Returns the privileged level of the file. This should be a value from 0 to 3 where the lower the number, the higher the privileged level.

5014

Released (B) Put: Yes; Verify: Yes; Release 3.0

Returns or modifies whether the file is released or secure. True when the file is released and false when the file is secure. This file aspect can be changed using the RELEASE and SECURE commands if you are the file's creator.

5015

Temporary (B) Put: No; Verify: Yes; Release 3.0

Returns true if the file is temporary and false if it is permanent.

5016

Record Size (U32) Put: No; Verify: Yes; Release 3.0

The file's record size in bytes. For variable-length records, the size of the largest record is returned.

5017

End of File (U32) Put: No; Verify: Yes; Release 3.0

Returns the current number of bytes in the file. This item should be used as an unsigned integer. The number of records in the file can be calculated by the formula:

#of records =(EOF - (256*Number of User Labels))/Record Size
5018

File limit (U32) Put: No; Verify: Yes; Release 3.0

Returns the maximum number of bytes that the file is allowed to have. This item should be used as an unsigned integer.

5019

Number of User Labels (I32) Put: No; Verify: Yes; Release 3.0

Returns the number of user labels that have been allocated for this file. This should be a value from 0 to 254.

5020

User Labels Limit (I32) Put: No; Verify: Yes; Release 3.0

Returns the end of the user label area as a byte offset. This value can be divided by $100 to calculate the number of user labels written.

5021

Block Size (U32) Put: No; Verify: Yes

Returns the block size of the file in bytes. This should be the record size multiplied by the blocking factor.

5022

Blocking Factor (I32) Put: No; Verify: Yes; Release 3.0

Returns the blocking factor for the file. This is the number of records that will be placed in each block and should be a value from 1 to 255.

5023

Volume Restriction (CA34) Put: No; Verify: Yes; Release 3.0

Returns the file's volume restrictions. The last two characters indicate what the first 32 characters represent, as follows:

' 0'

File restricted to the volume name located in elements 1..32.

' 1'

File restricted to the volume class name located in elements 1..32.

' 2'

File restricted to the volume set name located in elements 1..32.

5024

Message File Open/Close Record Count (I32) Put: No; Verify: Yes; Release 3.0

Returns the number of open/close records. This is valid for message files only. For non-message files this value is zero.

5025

Number of Users (I32) Put: No; Verify: Yes; Release 3.0

Returns the number of users that have this file open on the system.

5026

Number of Readers (I32) Put: No; Verify: Yes; Release 3.0

Returns the number of users that have this file open with read access. This is valid only for NM files. (Not applicable to the system libraries.)

5027

Number of Writers (I32) Put: No; Verify: Yes; Release 3.0

Returns the number of users that have this file open with write access. This is valid only for NM files.

5028

Number of Record Pointers (I32) Put: No; Verify: Yes; Release 3.0

Returns the number of record pointers that are active for this file. This is valid only for NM files.

5029

Close Disposition (I32) Put: Yes; Verify: Yes; Release 3.0

Returns or modifies the disposition to be used when the file is closed by the last user accessing it. Values and their meanings are:

0

Null

1

Permanent

2

Temporary (rewind upon close)

3

Temporary (do not rewind)

4

Purge

5

Permanent to temporary (native mode files only)

Equivalent to the HPFOPEN final disposition option.

5030

Virtual Address (@64) Put: No; Verify: Yes; Release 3.0

Returns the virtual address of the file.

5031

Any Access Rights (U32) Put: Yes; Verify: Yes; Release 3.0

Returns or modifies the access rights for any user.

Bits (0:24)

Unused

Bit (24:1)

Read

Bit (25:1)

Write

Bit (26:1)

Execute

Bit (27:1)

Append

Bit (28:1)

Lock

Bit (29:1)

Save

Bit (30:1)

Update

Bit (31:1)

Dir_read

5032

Group Access Rights (U32) Put: Yes; Verify: Yes; Release 3.0

Returns or modifies the group access rights.

Bits (0:24)

Unused

Bit (24:1)

Read

Bit (25:1)

Write

Bit (26:1)

Execute

Bit (27:1)

Append

Bit (28:1)

Lock

Bit (29:1)

Save

Bit (30:1)

Update

Bit (31:1)

Dir_read

5033

Group Librarian Access Rights (U32) Put: Yes; Verify: Yes; Release 3.0

Returns or modifies the group librarian access rights.

Bits (0:24)

Unused

Bit (24:1)

Read

Bit (25:1)

Write

Bit (26:1)

Execute

Bit (27:1)

Append

Bit (28:1)

Lock

Bit (29:1)

Save

Bit (30:1)

Update

Bit (31:1)

Dir_read

5034

Account Access Rights (U32) Put: Yes; Verify: Yes; Release 3.0

Returns or modifies the account access rights.

Bits (0:24)

Unused

Bit (24:1)

Read

Bit (25:1)

Write

Bit (26:1)

Execute

Bit (27:1)

Append

Bit (28:1)

Lock

Bit (29:1)

Save

Bit (30:1)

Update

Bit (31:1)

Dir_read

5035

Account Librarian Access Rights (U32) Put: Yes; Verify: Yes; Release 3.0

Returns or modifies the account librarian access rights.

Bits (0:24)

Unused

Bit (24:1)

Read

Bit (25:1)

Write

Bit (26:1)

Execute

Bit (27:1)

Append

Bit (28:1)

Lock

Bit (29:1)

Save

Bit (30:1)

Update

Bit (31:1)

Dir_read

5036

Pathname (REC) Put: No; Verify Yes; Release 4.5

Returns the pathname in the record format defined by pathname_type. The name is returned as an absolute pathname (for example, /SYS/PUB/NL).

Record type: pathname_type

5037

Path Identifier (REC) Put: No; Verify: Yes; Release 4.5

Returns the unique path identifier associated with the specified pathname.

Record type: path_identifier

5038

Running Link Count (U32) Put: No; Verify: Yes; Release 4.5

Returns the total number of links that have been performed on this file since it was created. It does not indicate the current number of links; it is simply a running count. Use item 5046 to get the current number of links.

5039

File type (U32) Put: No; Verify: Yes; Release 4.5

Returns the file type. Possible values are:

0 -

ordinary

1 -

ksam

2 -

relative_io

3 -

nm_ksam

4 -

circular

5 -

spool

6 -

message

7 -

resv

8 -

cmfile

9 -

dir_obj

10 -

label_table

11 -

xm_syslog

12 -

pipe

13 -

fifo

14 -

symbolic link

15 -

device link

5040

Record type (U32) Put: No; Verify: Yes; Release 4.5

Returns the file record type. Possible values are:

0 -

fixed

1 -

variable

2 -

undefined

3 -

cm_spool

4 -

account directory node

5 -

user directory node

6 -

group directory node

7 -

fileset directory node

8 -

temporary directory

9 -

byte_stream

10 -

hierarchical directory

5041

File Owner (CA36) Put: Yes; Verify: Yes; Release 4.5

Returns or modifies the full file owner name. The name is in the format USER.ACCOUNT and is padded with blanks. Note that this item should be used instead of item 5003 to get the full file owner. With the Hierarchical File System, the creator field has been replaced with the concept of a file owner. This is because file ownership can now change through the use of the chown function.

Note that for MPE directory files existing prior to MPE/iX release 4.5, the creator field will not be initialized. For those files, blanks will be returned.

5042

ACD Required (B) Put: No; Verify: Yes; Release 4.5

Returns true if the file must have an ACD to establish its security policy. If this flag is false, the file may have an ACD in effect.

5043

File_group (CA16) Put: No; Verify: Yes; Release 4.5

Returns the name of the file sharing group that the file belongs to. This field is the text form of the 32 bit GID value from the HPGID.PUB.SYS file. This value is inherited from the parent directory and may change through the use of the HPSETOWNER intrinsic.

5044

State Change Timestamp (REC) Put: Yes; Verify: Yes; Release 4.5

Returns or modifies the number of microseconds from January 1, 1970 to the time that the file label was last changed. This timestamp is a new field in the file label which was added to meet POSIX standards. Although this item gives you control over the timestamp, it should be updated whenever the file label changes. If you do not specify this item or item 5045, then the timestamp is updated automatically with the current time during any AIFFILEGPUT operation that affects the file label.

Record type: longint_type (Refer to Data Type Definition.)

5045

Update State Change Timestamp? (B) Get: No; Put: Yes; Verify: No; Release 4.5

Indicates whether or not to automatically update the state change timestamp during any AIFFILEGPUT operation which effects the file label. The current time will be used unless a value is specified in item 5044. If item 5044 is specified, then the timestamp will be updated with the user specified value regardless of whether or not this flag is specified.

Defaults to true (that is, update timestamp automatically).

5046

Current Link Count (U32) Put: No; Verify: Yes; Release 4.5

Returns the current number of links (hard links) for this file.

5047

Number of extents (I32) Put: No; Verify: Yes; Release 4.5

Number of extents used by the file.

5048

Number of Sectors (I32) Put: No; Verify: Yes; Release 4.5

Number of sectors used by a file.

5051

Don't Follow Symbolic Link (B) Put: No; Verify: Yes; Release 5.0

This item is used as an option to determine whether the information returned by AIFFILEGGET is about the symbolic link or the resolved link (resolution of the symbolic link). The default is to resolve the symbolic link. This is only valid when either a pathname or MPE file name is passed to AIFFILEGGET. For pathnames, true means AIFFILEGGET does not resolve the last component of a pathname if it is a symbolic link. For pathnames, false means the full path is resolved. To locate symbolic links, use 14 the symbolic link file type (of item 5039) with AIFSYSWIDEGET (The callers can control the information returned by either setting the passed value to true or false).

 

Feedback to webmaster