OpenVMS マニュアル

指定されたファイルの属性に関する情報を戻します。

形式

F$FILE_ATTRIBUTES (ファイル指定，項目)

戻り値

引数

ファイル指定

情報が必要なファイルの名前。ファイル名は文字列式として指定します。

ファイル名は，1 つしか指定することができません。ファイル指定の中で，ワイルドカード文字を使用することはできません。

項目

ファイルのどの属性を戻してほしいか指定します。項目は，文字列式として指定します。 表 1-5 の RMS フィールド名から 1 項目を指定します。

説明

DCL 割り当て文および式で使用して，ファイルの属性に関する情報を戻します。 表 1-5 は F$FILE_ATTRIBUTES 関数に指定する項目，戻される情報，その情報のデータ・タイプを示しています。

表 1-5 F$FILE_ATTRIBUTES 項目

項目	データ・タイプ	戻される情報
AI	文字列	AI ジャーナリングが設定されていれば TRUE。設定されていなければ FALSE。
ALQ	整数値	割り当てサイズ
BDT	文字列	バックアップ日付
BI	文字列	BI ジャーナリングが設定されていれば TRUE。設定されていなければ FALSE。
BKS	整数値	バケット・サイズ
BLS	整数値	ブロック・サイズ
CBT	文字列	contiguous-best-try 割り当てアルゴリズムが使用されていれば TRUE。使用されていなければ FALSE。
CDT	文字列	作成日付
CTG	文字列	contiguous 割り当てアルゴリズムが使用されていれば TRUE。使用されていなければ FALSE。
DEQ	整数値	省略時の拡張サイズ
DID	文字列	ディレクトリ ID
DIRECTORY	文字列	TRUE あるいは FALSE を返す。ディレクトリである場合は TRUE を返す。
DVI	文字列	装置名
EDT	文字列	満了日付
EOF	整数値	使用ブロック数
ERASE	文字列	削除時に物理的に削除される場合は TRUE。物理的に削除されない場合は FALSE。
FFB	整数値	先頭空きバイト
FID	文字列	ファイル ID
FILE_LENGTH_HINT	文字列	レコード数およびデータのバイト数を ( n,m) の形式で返す。ここで n はレコード数で， m はデータのバイト数である。無効な数は， n あるいは m に -1 が返される。
FSZ	整数値	固定制御領域サイズ
GBC	整数値	グローバル・バッファ数
GBC32	整数値	グローバル・バッファ数の拡張ロングワード版。ファイルごとの最大サイズは，インデックス付きファイルの場合，約 21 億。
GBCFLAGS	文字列	グローバル・バッファ・キャッシュのサイズ設定の，ファイルごとの監視フラグ。グローバル・バッファ・カウントがパーセントで表されていれば PERCENT が返され，実行時に 2 つのグローバル・バッファ SYSGEN パラメータ (GB_CACHEALLMAX と GB_DEFPERCENT) を使用するアルゴリズムによってグローバル・バッファ・サイズが決定される場合は DEFAULT が返される。または，ファイルに対して有効になっているファイルごとの管理フラグがない場合は，NONE が返される。
GRP	整数値	所有者グループ番号
JOURNAL_FILE	文字列	ジャーナル・ファイルの場合は TRUE。ジャーナル・ファイルではない場合は FALSE。
KNOWN	文字列	Known ファイルがインストール・ユーティリティ(INSTALL) ともにインストールされた場合は TRUEを，そうでない場合は FALSE を返す。ただし，ファイルが存在しない場合 ( たとえば，ファイルがインストールされた直後に削除された場合 ) は，NOSUCHFILE を返す。
LOCKED	文字列	アクセスが許可されないロック状態の場合は TRUE。そうでない場合は FALSE。
LRL	整数値	最大レコード長
MBM	整数値	所有者メンバ番号
MOVE	文字列	movefile 操作が可能な場合は TRUE。そうでない場合は FALSE。
MRN	整数値	最大レコード数
MRS	整数値	最大レコード・サイズ
NOA	整数値	エリア数
NOBACKUP	文字列	バックアップ用にファイルがマークされている場合は FALSE。 NOBACKUP のマークがついている場合は TRUE。
NOK	整数値	キー数
ORG	文字列	ファイル編成法 (SEQ, REL, IDX)
PRESHELVED (Alpha/Integrity のみ)	文字列	ファイルがプリシェルブドである場合 TRUE。そうでない場合，FLASE。
PRO	文字列	ファイル保護文字列
PVN	整数値	プロローグ・バージョン番号
RAT	文字列	レコード属性 (CR, PRN, FTN, "")
RCK	文字列	読込みチェックが設定されている場合は TRUE。そうでない場合は FALSE。
RDT	文字列	最新更新日付
RFM	文字列	レコード・フォーマット (VAR, FIX, VFC, UDF, STM, STMLF, STMCR)
RU	文字列	RU ジャーナリングが設定されている場合は TRUE。設定されていない場合は FALSE。
RVN	整数値	改訂番号
SHELVABLE	文字列	ファイルがシェルブド可能な場合は TRUE。不可能な場合は FALSE。
SHELVED	文字列	ファイルがシェブルドの場合は TRUE。そうでない場合は FALSE。
STORED_ SEMANTICS	文字列	セマンティックスを表す ASCII 文字列
UIC	文字列	所有者 UIC 文字列
VERLIMIT	整数値	バージョン・リミット番号。 32767 はバージョン・リミットが設定されていないことを示す。
WCK	文字列	書込みチェックが設定されている場合は TRUE。設定されていない場合は FALSE。

ファイル属性は OpenVMS RMS 制御ブロックの情報から作られたファイル・ヘッダに格納されます。 OpenVMS RMS 制御ブロックについての詳細は『OpenVMS Record Management Services Reference Manual』を参照してください。

例

$ FILE_ORG = F$FILE_ATTRIBUTES("QUEST.DAT","ORG")
$ SHOW SYMBOL FILE_ORG
  FILE_ORG = "SEQ"

この例では，ファイル編成タイプの値を FILE_ORG というシンボルに割り当てるために， F$FILE_ATTRIBUTES 関数が使用されています。 F$FILE_ATTRIBUTES 関数は，"SEQ" という文字列を戻します。これは QUEST.DAT が順編成ファイルであることを示します。

F$FILE_ATTRIBUTES 関数に対する ORG 引数および QUEST.DAT 引数は，文字列リテラルであり，式の中で使用するときは二重引用符で囲まなければなりません。

$ RFM = F$FILE_ATTRIBUTES("KANSAS::USE$:[CARS]SALES.CMD","RFM")
$ SHOW SYMBOL RFM
  RFM = "VAR"

この例では，リモート・ノードのファイルに関する情報を戻すために， F$FILE_ATTRIBUTES 関数が使用されています。この関数は，VAR というレコード形式文字列を戻します。これはレコード形式が可変長レコードであることを示します。