HPACDINFO [ MPE/iX Intrinsics Reference Manual ] MPE/iX 5.0 Documentation
MPE/iX Intrinsics Reference Manual
HPACDINFO
Lists security information from the access control definition (ACD) of a
specified file or device.
Syntax
______________________________________
| |
| I32 IV *|
| HPACDINFO(status,itemnum1,item1|
| |
| |
| |
| |
| IV * |
| [,itemnum2,item2][,...]); |
______________________________________
NOTE A maximum of four itemnum2/item2 pairs can be specified. The last
specified itemnum2/item2 pair takes precedence over all identical
itemnum2/item2 pairs specified. Any conflict produces a warning
message.
Parameters
status 32-bit signed integer by reference (required)
Returns the status of the HPACDINFO call. If no
errors or warnings are encountered, status returns
32-bits of zero. If errors or warnings are
encountered, status is interpreted as two 16-bit
fields:
Bits (0:16) comprise status.info. A negative value
indicates an error condition, and a positive value
indicates a warning condition. Refer to the MPE/iX
Error Message Manual Volumes 1, 2 and 3
(32650-90066, 32650-90152, and 32650-90368) for a
description of its value.
Bits (16:16) comprise status.subsys. The value
represents the subsystem that sets the status
information. The subsystem identifier for
HPACDINFO is 246.
itemnum1 integer by value (required)
Passes the number indicating the item. Refer to
Table 4-11 .
item1 Type varies (required)
Passes the file or device identification
information as specified in itemnum. Refer to
Table 4-11 .
itemnum2 integer by value (optional)
Passes the number indicating the item2. Refer to
Table 4-12 .
item2 Type varies (optional)
Returns the variable information as specified in
itemnum2. Refer to Table 4-12 .
Table 4-11. HPACDINFO Itemnum1/Item1 Values
-----------------------------------------------------------------------------------------------
| | | |
| Itemnum | Mnemonic | Item Description |
| | | |
-----------------------------------------------------------------------------------------------
| |
| The following constants have been defined for a file or device request: |
| |
-----------------------------------------------------------------------------------------------
| | | |
| 1 | BA | Specifies the target file name. The item1 value specified must be a |
| | | byte array of 1 to 35 characters (for MPE filenames), word aligned. |
| | | Note that no wildcard characters are allowed, a lockword can be |
| | | included, and the file name specified does not need to be fully |
| | | qualified and can be specified using an MPE or HFS name syntax. HFS |
| | | pathnames must begin with a dot (.) or slash (/) character and |
| | | cannot exceed 1024 characters including the dot or slash. MPE |
| | | filenames < 35 characters must be terminated with a null character or |
| | | a carriage return. |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| 3 | UDS | Specifies the unique file identifier (UFID). The item1 value |
| | | specified must be a 20-byte structure, which can be obtained from the |
| | | file system through the HPFOPEN, FLABELINFO, or FFILEINFO intrinsics. |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| 4 | I | Specifies the file identifier of a previously opened file. The item1 |
| | | value specified must be a 16-bit integer value. |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| 6 | I | Specifies the logical device number (ldev). The item1 value |
| | | specified must be a 16-bit integer value. |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| 7 | BA | Specifies the name of a specific device. The item1 value specified |
| | | must be a 1 to 8 character byte array. |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| 1 | BA | Specifies the target file name. The item1 value specified must be a |
| | | byte array of 1 to 35 characters (for MPE filenames), word aligned. |
| | | Note that no wildcard characters are allowed, a lockword can be |
| | | included, and the file name specified does not need to be fully |
| | | qualified and can be specified using an MPE or HFS name syntax. HFS |
| | | pathnames must begin with a dot (.) or slash (/) character and |
| | | cannot exceed 1024 characters including the dot or slash. MPE |
| | | filenames < 35 characters must be terminated with a null character or |
| | | a carriage return. |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| 3 | UDS | Specifies the unique file identifier (UFID). The item1 value |
| | | specified must be a 20-byte structure, which can be obtained from the |
| | | file system through the HPFOPEN, FLABELINFO, or FFILEINFO intrinsics. |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| 4 | I | Specifies the file identifier of a previously opened file or |
| | | directory. The item1 value specified must be a 16-bit integer value. |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| 6 | I | Specifies the logical device number (ldev). The item1 value |
| | | specified must be a 16-bit integer value. |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| 7 | BA | Specifies the name of a specific device. The item1 value specified |
| | | must be a 1 to 8 character byte array. |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| 15 | BA | Specifies the target filename. The item1 value specified must be a |
| | | byte array of < 1024 characters long inluding the terminating |
| | | carriage return, blank, or null character. |
| | | |
-----------------------------------------------------------------------------------------------
Table 4-12. HPACDINFO Itemnum2/Item2 Values
-----------------------------------------------------------------------------------------------
| | | |
| Itemnum | Mnemonic | Item Description |
| | | |
-----------------------------------------------------------------------------------------------
| |
| Security information that is not user-dependent can be requested using the following |
| itemnum2/item2 pairs: |
| |
-----------------------------------------------------------------------------------------------
| | | |
| 20 | A | Returns a unique identifier representing the current version of the |
| | | ACD. Currently the version number is 5. The item2 value returned is |
| | | a 16-bit integer. |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| 21 | I | Returns the number of ACD entries located in the target file ACD. The |
| | | item2 value returned is a 16-bit integer. |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| 22 | BA | Returns a unique identifier representing the first user specified in |
| | | the ACD. The item value returned is a 1 to 18 character byte array. |
| | | |
-----------------------------------------------------------------------------------------------
Table 4-12. HPACDINFO Itemnum2/Item2 Values (cont.)
-----------------------------------------------------------------------------------------------
| | | |
| Itemnum | Mnemonic | Item Description |
| | | |
-----------------------------------------------------------------------------------------------
| |
| Security information that is user-dependent can be requested using the following |
| itemnum2/item2 pairs: |
| |
-----------------------------------------------------------------------------------------------
| | | |
| 30 | BA | Specifies the user whose ACD information is to be returned. The |
| | | item2 value specified must be an 18-character byte array, word |
| | | aligned. If it is <18 characters, it must be terminated with a null |
| | | character or a carriage return. This entry is required for |
| | | subsequent user-dependent requests. |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| 31 | BA | Returns ACD modes in ASCII format. The item2 value returned is a |
| | | 25-character byte array. |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| 32 | I | Returns ACD modes as a bit mask. The item2 value returned is a |
| | | 16-bit integer whose bits have the following meaning: |
| | | |
| | | r (0:1) - READ |
| | | w (1:1) - WRITE |
| | | x (2:1) - EXECUTE |
| | | a (3:1) - APPEND |
| | | l (4:1) - LOCK |
| | | z (8:1) - Permission to read |
| | | rd (11.1) - |
| | | td (12.1) - |
| | | cd (13.1) - |
| | | dd (14.1) - |
| | | n (15:1) - No access |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| 33 | BA | Returns ACD modes in ASCII format as access is granted the particular |
| | | user. The item2 value returned is a 25-character byte array. All |
| | | wildcards are matched from the user specification. The access |
| | | granted the user in the selected ACD pair can be greater than the |
| | | access specified in the ACD pair if the user has AM or SM capability. |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| 34 | I | Returns ACD modes as a bit mask of all accesses granted the |
| | | particular user. The item2 value returned is a 16-bit integer whose |
| | | bits have the following meanings: |
| | | |
| | | r (0:1) - READ |
| | | w (1:1) - WRITE |
| | | x (2:1) - EXECUTE |
| | | a (3:1) - APPEND |
| | | l (4:1) - LOCK |
| | | z (8:1) - Permission to read |
| | | rd (11.1) - |
| | | td (12.1) - |
| | | cd (13.1) - |
| | | dd (14.1) - |
| | | n (15:1) - No access |
| | | |
| | | All wildcards are matched from the user specification. The access |
| | | granted the user in the selected ACD pair can be greater than the |
| | | access specified in the ACD pair if the user has AM or SM capability. |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| 35 | BA | Returns the next user in the ACD. The item2 value returned is a 1 to |
| | | 18 character byte array. |
| | | |
-----------------------------------------------------------------------------------------------
Operation Notes
The HPACDINFO intrinsic lists the requested security attributes of a
specified file or device. Three types of itemnum/item pair descriptors
can be used to define supplied input or to specify returned ACD
information. Such descriptors identify the file or device and request
nonuser-dependent and user-dependent data.
Related Information
Intrinsics HPACDPUT, HPFOPEN
Commands LISTF, LISTFILE, SHOWDEV
Manuals MPE/iX Commands Reference Manual Volumes 1 and 2
(32650-90003 and 32650-90364), System Startup,
Configuration, and Shutdown Reference Manual
(32650-90042), MPE/iX Utilities Manual
(32650-90081), and Controlling System Activity
(32650-90155)
MPE/iX 5.0 Documentation