|
|
(2 intermediate revisions by 2 users not shown) |
Line 1: |
Line 1: |
− | '''F$GETSYI()''' is a [[Lexical function|lexical function]] that returns status and identification information about the local system (or about a node in the local mixed-architecture OpenVMS Cluster system, if your system is part of an OpenVMS Cluster). | + | <nowiki>Insert non-formatted text here</nowiki>'''F$GETSYI()''' is a [[Lexical functions|lexical function]] that returns status and identification information about the local system (or about a node in the local mixed-architecture OpenVMS Cluster system, if your system is part of an OpenVMS Cluster). |
| | | |
| =Format= | | =Format= |
Line 7: |
Line 7: |
| ==item== | | ==item== |
| | | |
− | In addition to the items below, you can specify any [[System Parameters|system parameter]]. | + | In addition to the [[$GETSYI#Item Codes|$GETSYI items]] (subtract "SYI$_" from their names to get F$GETSYI items), you can specify any [[System Parameters|system parameter]]. |
− | | |
− | {| class="wikitable"
| |
− | |-
| |
− | ! Item !! Return Type !! Information Returned
| |
− | |-
| |
− | | AI || style="text-align:center;" | String || TRUE if after-image (AI) journaling is enabled; FALSE if disabled.
| |
− | |-
| |
− | | ALQ || style="text-align:center;" | Integer || Allocation quantity.
| |
− | |-
| |
− | | BDT || style="text-align:center;" | String || Backup date/time.
| |
− | |-
| |
− | | BI || style="text-align:center;" | String || TRUE if before-image (BI) journaling is enabled; FALSE if disabled.
| |
− | |-
| |
− | | BKS || style="text-align:center;" | Integer || Bucket size.
| |
− | |-
| |
− | | BLS || style="text-align:center;" | Integer || Block size.
| |
− | |-
| |
− | | CBT || style="text-align:center;" | String || TRUE if contiguous-best-try; otherwise FALSE.
| |
− | |-
| |
− | | CDT || style="text-align:center;" | String || Creation date/time.
| |
− | |-
| |
− | | CTG || style="text-align:center;" | String || TRUE if contiguous; otherwise FALSE.
| |
− | |-
| |
− | | DEQ || style="text-align:center;" | Integer || Default extension quantity.
| |
− | |-
| |
− | | DID || style="text-align:center;" | String || Directory ID string.
| |
− | |-
| |
− | | DIRECTORY || style="text-align:center;" | String || Returns TRUE or FALSE. Returns TRUE if it is a directory.
| |
− | |-
| |
− | | DVI || style="text-align:center;" | String || Device name string.
| |
− | |-
| |
− | | EDT || style="text-align:center;" | String || Expiration date/time.
| |
− | |-
| |
− | | EOF || style="text-align:center;" | Integer || Number of blocks used.
| |
− | |-
| |
− | | ERASE || style="text-align:center;" | String || TRUE if a file's contents are erased before a file is deleted; otherwise FALSE.
| |
− | |-
| |
− | | FFB || style="text-align:center;" | Integer || First free byte.
| |
− | |-
| |
− | | FID || style="text-align:center;" | String || File ID string.
| |
− | |-
| |
− | | FILE_LENGTH_HINT || style="text-align:center;" | String || Record count and data byte count in the form (
| |
− | |-
| |
− | | FSZ || style="text-align:center;" | Integer || Fixed control area size.
| |
− | |-
| |
− | | GBC || style="text-align:center;" | Integer || Global buffer count.
| |
− | |-
| |
− | | GBC32 || style="text-align:center;" | Integer || Enhanced longword version of global buffer count with a per-file maximum size of about 2.1 billion for indexed files.
| |
− | |-
| |
− | | GBCFLAGS || style="text-align:center;" | String || Per-file management flags for sizing of global buffer cache. Returns PERCENT if global buffer count is expresses as a percent, DEFAULT if global buffer size is determined at runtime by an algorithm using two global buffer SYSGEN parameters (GB_CACHEALLMAX and GB_DEFPERCENT); or NONE if no per-file management flags are enabled for the file.
| |
− | |-
| |
− | | GRP || style="text-align:center;" | Integer || Owner group number.
| |
− | |-
| |
− | | JOURNAL_FILE || style="text-align:center;" | String || TRUE if the file is a journal; otherwise FALSE.
| |
− | |-
| |
− | | KNOWN || style="text-align:center;" | String || Known file; returns TRUE or FALSE to indicate whether file is installed with the Install utility (INSTALL). However, returns NOSUCHFILE if a file does not exist (for example, the file has been installed but subsequently deleted).
| |
− | |-
| |
− | | LOCKED || style="text-align:center;" | String || TRUE if a file is deaccessed-locked; otherwise FALSE.
| |
− | |-
| |
− | | LRL || style="text-align:center;" | Integer || Longest record length.
| |
− | |-
| |
− | | MBM || style="text-align:center;" | Integer || Owner member number.
| |
− | |-
| |
− | | MOVE || style="text-align:center;" | String || TRUE if movefile operations are enabled; otherwise FALSE.
| |
− | |-
| |
− | | MRN || style="text-align:center;" | Integer || Maximum record number.
| |
− | |-
| |
− | | MRS || style="text-align:center;" | Integer || Maximum record size.
| |
− | |-
| |
− | | NOA || style="text-align:center;" | Integer || Number of areas.
| |
− | |-
| |
− | | NOBACKUP || style="text-align:center;" | String || FALSE if the file is marked for backup; TRUE if the file is marked NOBACKUP.
| |
− | |-
| |
− | | NOK || style="text-align:center;" | Integer || Number of keys.
| |
− | |-
| |
− | | ORG || style="text-align:center;" | String || File organization; returns SEQ, REL, IDX.
| |
− | |-
| |
− | | PRESHELVED (Alpha/Integrity servers only) || style="text-align:center;" | String || TRUE if the file is preshelved; otherwise FALSE.
| |
− | |-
| |
− | | PRO || style="text-align:center;" | String || File protection string.
| |
− | |-
| |
− | | PVN || style="text-align:center;" | Integer || Prolog version number.
| |
− | |-
| |
− | | RAT || style="text-align:center;" | String || Record attributes; returns CR, PRN, FTN, "".
| |
− | |-
| |
− | | RCK || style="text-align:center;" | String || TRUE if read check; otherwise FALSE.
| |
− | |-
| |
− | | RDT || style="text-align:center;" | String || Revision date/time.
| |
− | |-
| |
− | | RFM || style="text-align:center;" | String || Record format string; returns the values VAR, FIX, VFC, UDF, STM, STMLF, STMCR.
| |
− | |-
| |
− | | RU || style="text-align:center;" | String || TRUE if recovery unit (RU) journaling is enabled; returns TRUE or FALSE.
| |
− | |-
| |
− | | RVN || style="text-align:center;" | Integer || Revision number.
| |
− | |-
| |
− | | SHELVABLE || style="text-align:center;" | String || TRUE if the file is shelvable; otherwise FALSE.
| |
− | |-
| |
− | | SHELVED || style="text-align:center;" | String || TRUE if the file is shelved; otherwise FALSE.
| |
− | |-
| |
− | | STORED_SEMANTICS || style="text-align:center;" | String || ASCII string that represents stored semantics.
| |
− | |-
| |
− | | UIC || style="text-align:center;" | String || Owner user identification code (UIC) string.
| |
− | |-
| |
− | | VERLIMIT || style="text-align:center;" | Integer || Version limit number. The value 32767 indicates that no version limit was set.
| |
− | |-
| |
− | | WCK || style="text-align:center;" | String || TRUE if write check; otherwise FALSE.
| |
− | |}
| |
| | | |
| ==node-name== | | ==node-name== |
Insert non-formatted text hereF$GETSYI() is a lexical function that returns status and identification information about the local system (or about a node in the local mixed-architecture OpenVMS Cluster system, if your system is part of an OpenVMS Cluster).
Format
F$GETSYI (item [,node-name] [,cluster-id])
item
In addition to the $GETSYI items (subtract "SYI$_" from their names to get F$GETSYI items), you can specify any system parameter.
node-name
Specifies the node in your OpenVMS Cluster system for which information is to be returned. Specify the node as a character string expression. You cannot use the asterisk (*) and the percent sign (%) wildcard characters to specify the node-name argument.
cluster-id
Specifies the cluster node identification number for which the information is to be returned.
To get information for all the nodes in a cluster, use the F$CSID lexical function to obtain each cluster system identification number, and use the cluster-id argument of F$GETSYI to gather information about each node.
Examples
$ SYSID = F$GETSYI("SID")
$ SHOW SYMBOL SYSID
SYSID = 19923201 Hex = 01300101 Octal = 000401
$ MEM = F$GETSYI("CLUSTER_MEMBER", "LONDON")
$ SHOW SYMBOL MEM
MEM = "TRUE"
$ LIM = F$GETSYI("IJOBLIM")
$ SHOW SYMBOL LIM
LIM = 16 Hex = 00000010 Octal = 00000000020
$ DECNETVERS = F$GETSYI("DECNET_VERSION")
$ SHOW SYMBOL DECNETVERS
DECNETVERS = "00050D01"
$ DECNETPHASE = F$INTEGER(F$EXTRACT(2,2,DECNETVERS))
$ SHOW SYMBOL DECNETPHASE
DECNETPHASE = 5 Hex = 00000005 Octal = 00000000005
$ RADCPU = F$GETSYI("RAD_CPUS")
$ SHOW SYMBOL RADCPU
0,0,0,1,1,4,1,5