ATMI FML関数リファレンス

セクション3fml - FML関数

FML関数の紹介

形式

“#include <fml.h>”
“#include <fml32.h>”

説明

FMLは、フィールド化バッファと呼ばれる記録構造を定義、操作する一連のC言語関数で、フィールド化バッファにはフィールドと呼ばれる属性と値の対が含まれます。属性はフィールドの識別子であり、対応する値はフィールドのデータ内容を表します。

フィールド化バッファを使用すると、関連したフィールドのセットを名前でアクセスできるので、協調動作するプロセス間でパラメータ化されたデータを受け渡す場合に便利です。他のプロセスとコミュニケートする必要のあるプログラムは、FMLソフトウェアを使用し、フィールドを含む構造体を意識せずにフィールドへのアクセスが可能です。

FMLはまた、VIEWSと呼ばれる、フィールド化バッファをC構造体にマップする(その逆も可能)機能も提供します。VIEWSでは、フィールド化バッファではなく構造体において時間のかかるデータの処理を実行できます。データを処理するために構造体に転送すると、アプリケーションの実行速度が向上します。このように、VIEWSを使用すると、フィールド化バッファのデータ独立性と従来のレコード構造の効率性、簡便性をともに享受することができます。

FML16とFML32

FMLには2つのサイズがあります。オリジナルのFMLインタフェースは、フィールド長に16ビットの値を使用して、フィールドを識別する情報を格納します。このマニュアル・ページでは、これらをFML16と呼びます。FML16では、一意のフィールド数は8191、個々のフィールド長は最大64Kバイト、フィールド化バッファの総容量は64Kに制限されます。このインタフェースの定義、型、および関数のプロトタイプはfml.hに定義され、FML16インタフェースを使用するアプリケーション・プログラムは、このファイルをインクルードする必要があります。各関数は、-lfmlにあります。FML32は、フィールド長と識別子に32ビットの値を使用します。約3千万のフィールド、約20億バイトのフィールド長およびバッファ長が使用できます。FML32の定義、型、および関数のプロトタイプは、fml32.h内にあります。各関数は、-lfml32にあります。FML32のすべての定義、型、および関数名には「32」という接尾辞が付きます(たとえば、MAXFBLEN32、FLDID32、Fchg32)。また、環境変数にも接頭辞 “32"が付きます(FLDTBLDIR32、FIELDTBLS32、VIEWFILES32、VIEWDIR32など)。

FMLバッファ

フィールド化バッファは、フィールド識別子とフィールド値の対(long, shortなど固定長フィールドの場合)、またはフィールド識別子、フィールド長、フィールド値の三揃い(可変長フィールドの場合)で構成されます。

フィールド識別子は、フィールド化バッファ内の個別のデータに付加されるタグです。フィールド識別子は、フィールド番号の名前およびフィールド内のデータの型で構成されます。フィールド番号はFML16では1 - 8191の範囲内、フィールド識別子の型定義はFLDIDです。フィールド番号はFML32では1 - 33,554,431の範囲内、フィールド識別子の型定義はFLDID32です。Oracle Tuxedo ATMIシステムは、フィールドに関する以下の規則に従っています。

Oracle Tuxedo ATMIシステムでは強制的に使用不可にはなっていませんが、アプリケーションが予約番号を使用しないようにしてください。

フィールドの型は、標準C言語の型のいずれでもかまいません(short、long、float、double、およびchar)。他に、string型(NULL文字で終了する文字列)、carray型(文字配列)、mbstring型(マルチバイト文字配列 - Oracle Tuxedoリリース8.1またはそれ以降で使用可能)、ptr型(バッファを指すポインタ)、FML32型(埋込み型のFML32バッファ)、およびVIEW32型(埋込み型のVIEW32バッファ)がサポートされています。ptr型、fml32型、およびview32型は、FML32インタフェースでのみサポートされています。fml.hでは、サポートされるフィールド型はFLD_SHORT、FLD_LONG、FLD_FLOAT、FLD_DOUBLE、FLD_CHAR、FLD_STRING、およびFLD_CARRAYとして定義されます。fml32.hでは、サポートされるフィールド型はFLD_SHORT、FLD_LONG、FLD_FLOAT、FLD_DOUBLE、FLD_CHAR、FLD_STRING、FLD_CARRAY、FLD_MBSTRING、FLD_PTR、FLD_FML32、およびFLD_VIEW32として定義されます。

FML16では、フィールド化バッファのポインタは、FBFR *型、フィールド長はFLDLEN型、フィールドのオカレンス数はFLDOCC型です。FML32では、フィールド化バッファのポインタはFBFR32 *型、フィールド長はFLDLEN32型、フィールドのオカレンス数はFLDOCC32型です。

フィールドは、FMLインタフェースのフィールド識別子により参照されます。ただし通常は、アプリケーション・プログラマにはフィールド名を覚える方が簡単です。フィールド名をフィールド識別子にマップするには、2つの方法があります。

実行時にFMLプログラムは、フィールド表ファイルを介してフィールド名と識別子のマッピング情報を取得できます(「field_tables(5)」を参照)。FML16インタフェースは、環境変数FLDTBLDIRを使用して、フィールド表が含まれるディレクトリのリストを指定し、FIELDTBLSを使用して、使用される表ディレクトリのファイルのリストを指定します。FML32インタフェースはFLDTBLDIR32とFIELDTBLS32を使用します。アプリケーション・プログラム内では、FML関数Fldid()およびFldid32()がフィールド名からフィールド識別子への実行時変換を行い、Fname()およびFname32()がフィールド識別子からフィールド名への変換を行います。

コンパイル時のフィールド名と識別子のマッピングは、フィールド名のマクロ定義を含むフィールド・ヘッダー・ファイルを使用して行われます。mkfldhdr()とmkfldhdr32()は、フィールド表ファイルからヘッダー・ファイルを作成するための関数です(「mkfldhdr、 mkfldhdr32(1)」を参照)。これらのヘッダー・ファイルはCプログラムの#includeで指定されます。これらを使用して、コンパイル時にフィールド名をフィールド識別子にマップすることもできます。

フィールド化バッファ内のフィールドは、複数回出現する場合があります。FML関数の多くが、検索または変更の対象にするフィールド・オカレンスを指定する引数を取ります。フィールドが複数回出現する場合、オカレンスは、最初のオカレンスを0として、順次番号付けされます。すべてのオカレンスが集まると、論理的なシーケンスを構成しますが、オカレンス番号に対応するオーバーヘッドはありません(つまり、オカレンス番号はフィールド化バッファに格納されません)。フィールド・オカレンスを追加すると、そのオカレンスは、オカレンスの集まりの最後に追加され、一番高い番号より1つ高い番号のオカレンスとして参照されます。一番高い番号のオカレンス以外のオカレンスを削除すると、削除されたオカレンスより高い番号のオカレンスはすべて、1つだけ下位にシフトします(たとえば、オカレンス6がオカレンス5になり、オカレンス5がオカレンス4になります)。

フィールド化バッファに多数のフィールドが含まれる場合、内部インデックスを使用すると、FMLでのアクセスが促進されます。通常、ユーザーはこのインデックスの存在を意識することはありません。フィールド化バッファをディスクに格納したり、プロセス間またはコンピュータ間で転送する場合は、まずFunindex()またはFunindex32()を使用してこのインデックスを削除すると、ディスク領域や転送時間を節約できます。後でインデックスが必要になれば、Findex()またはFindex32()を使用して再び作成します。

FML16からFML32への変換

適切に書かれた既存のFML16アプリケーションは、容易にFML32インタフェースを使用するように変更できます。FML関数の呼出しに使用する変数は、すべて適切なtypedef (FLDID、FLDLEN、およびFLDOCC)により定義されている必要があります。FML型付きバッファのためのtpalloc()呼出しには、FMLではなくFMLTYPE定義を使用します。アプリケーションのソース・コードに、fml.hのかわりにfml32.hを指定し、fml1632.hを組み込むことで32ビットの関数を使用できるようになります。fml1632.hには、すべての16ビットの型定義を32ビット版に変換したり、16ビットの関数やマクロを32ビット版に変換するマクロが含まれています。

VIEWS

VIEWSは、フィールド操作言語の一部です。この機能を使用すると、フィールドとC構造体のメンバーとのマッピングの指定によって、フィールド化バッファとC言語プログラムのC構造体の間でデータを受け渡しすることができます。フィールド化バッファの情報を大量に操作する場合は、データをC構造体内に転送するとパフォーマンスが向上します。VIEWS関数を使用して、フィールド化バッファ内の情報をバッファ内のフィールドから抽出してC構造体に置き、C構造体内でデータを操作した後、再度VIEWS関数を使用して、更新した値をフィールド化バッファに戻すことができます。

型付きバッファは、フィールド化バッファというFMLの概念に基づいたATMI環境の機能の1つです。ATMI環境と共に納入される2種類の標準バッファは、FML型付きバッファとVIEW型付きバッファです。このバッファがさらに異なる点は、VIEWバッファはFMLフィールド化バッファとの関連性がまったくなくてもよいということです。またFML32とVIEW32のバッファ型が使用される点でも異なります。

VIEW記述は、「viewfile(5)」で解説されるようにソースviewfileに作成、格納されます。VIEW記述は、フィールド化バッファ内のフィールドをC構造体内のメンバーにマップします。ソースVIEW記述は、viewc()またはviewc32()でコンパイルされ、VIEWオブジェクト・ファイルが生成されます。これは、フィールド化バッファとCプログラムのC構造体の間で転送されるデータのマッピングに使用されます(詳細については、「viewc、viewc32(1)」を参照)。また、VIEWコンパイラはアプリケーション・プログラムにインクルードするC言語のヘッダー・ファイルを作成し、VIEW記述で記述される構造体を定義します。VIEW逆アセンブラであるviewdis()またはviewdis32()は、オブジェクトVIEW記述を読取り可能な形式に変換する(つまり、ソースVIEW記述に戻す)ためのものです。逆アセンブラの出力は、VIEWコンパイラに再入力できます(詳細については、「viewdis、viewdis32(1)」を参照)。

VIEWFILESおよびVIEWDIR環境変数を使用してVIEW構造体を処理するために、実行時にオブジェクト・ファイルが使用されます。VIEWFILESに、アプリケーションのオブジェクトVIEWファイルのカンマ区切りのリストを指定する必要があります。フルパス名で指定したファイルはそのまま使用され、相対パス名で指定したファイルはVIEWDIR変数(下記参照)で指定したディレクトリのリストから検索されます。VIEWDIRには、相対ファイル名を指定したVIEWオブジェクト・ファイルを検索するために使用する、コロンで区切ったディレクトリのリストを指定します。VIEW32構造体ではVIEWFILES32およびVIEWDIR32が使用されます。

大半のFML関数によってサポートされているデータ型以外に、VIEWSはソースVIEW記述内でint型を間接的にサポートします。VIEW記述がコンパイルされると、VIEWコンパイラは、使用中のマシンの種類によって、すべてのint型をshort型かlong型に自動的に変換します。

VIEWSは、10進数データ型もサポートしています。これはdec_t型のフィールドとして定義され、パック10進数の値は総バイト数と小数点以下のバイト数として表されます。このようなフィールドは、FMLでは直接サポートされていませんが、このフィールドと、FMLでサポートされているほかのフィールドとの変換は自動的に行われます。パック10進数は、COBOL環境では2桁の10進数が1バイトにパックされ、下位バイトに符号が格納されます。C環境では、データ型は10進指数、符号、桁、およびパック10進数の値を含むdec_t型定義で定義されます。

FMLバッファはFvftos()またはFvftos32()を使用してビューに変換できます。ビューはFvstof()またはFvstof32()を使用してフィールド化バッファに変換できます。フィールド化バッファと構造体の間でデータ転送を行うと、ソース・データは自動的に宛て先データの型に変換されます。フィールドの複数オカレンスがサポートされています。これは構造体中の配列として扱われます。NULL値は構造体の空のメンバーを表すのに使用し、viewfileの構造体の各メンバーに対して指定できます。メンバーにNULL値を指定しないと、省略時のNULL値が使用されます。またC構造体のメンバーとフィールド化バッファ内のフィールドの間にマッピングが存在していても、それらの間でのデータの転送を禁止することができます。

VIEWは、目標レコード形式からの変換、または目標レコード形式への変換もできます。デフォルトの目標形式はIBM System/370 COBOLレコードです。Fvstot()関数によって、バイト・オーダー、浮動小数点、10進数形式、文字セット(ASCIIからEBCDIC)の変換が行われ、Fvttos()によって元の形式に戻されます。32ビット版の関数もあります。Fcodeset()関数を使用すると、別のASCII/EBCDIC変換表を指定できます。

エラー処理

ほとんどのFML関数は、1つまたは複数の戻り値を戻します。エラーの条件は、エラーの他には考えられない戻り値で示されます。通常、エラーであれば-1、不正なフィールド識別子(BADFLDID)またはアドレスであれば0です。またエラー・タイプが、外部整数Ferror (FML16の場合)、あるいはFerror32 (FML32の場合)として得られます。FerrorとFerror32は、正常呼出しではクリアされないので、エラーが示された後でのみテストします。

F_error()とF_error32()関数は、標準エラー出力にメッセージを出力します。これらは1つのパラメータ(文字列)を取り、引数の文字列にコロンと空白を付けて出力し、改行文字の後にエラー・メッセージを出力します。表示されるエラー・メッセージは、エラー発生時に設定されたFerrorまたはFerror32内の現在のエラー番号に対して定義されているメッセージです。

メッセージ・カタログからエラー・メッセージのテキストを検索するには、Fstrerror()を使用することができます。これらは、userlog(3c)への引数として使用できるポインタを返します。

エラー・コードのうち、FML機能で生成できるものについては、マニュアルのFMLの項目で説明しています。

関連項目

CFadd、CFadd32(3fml)、CFchg、CFchg32(3fml)、CFfind、CFfind32(3fml)、CFfindocc、CFfindocc32(3fml)、CFget、CFget32(3fml)、CFgetalloc、CFgetalloc32(3fml)、F_error、F_error32(3fml)、Fadd、Fadd32(3fml)、Fadds、Fadds32(3fml)、Falloc、Falloc32(3fml)、Fboolco、Fboolco32、Fvboolco、Fvboolco32(3fml)、Fboolev、Fboolev32、Fvboolev、Fvboolev32(3fml)、Fboolpr、Fboolpr32、Fvboolpr、Fvboolpr32(3fml)、Fchg、Fchg32(3fml)、Fchgs、Fchgs32(3fml)、Fchksum、Fchksum32(3fml)、Fcmp、Fcmp32(3fml)、Fconcat、Fconcat32(3fml)、Fcpy、Fcpy32(3fml)、Fdel、Fdel32(3fml)、Fdelall、Fdelall32(3fml)、Fdelete、Fdelete32(3fml)、Fextread、Fextread32(3fml)、Ffind、Ffind32(3fml)、Ffindlast、Ffindlast32(3fml)、Ffindocc、Ffindocc32(3fml)、Ffinds、Ffinds32(3fml)、Ffloatev、Ffloatev32、Fvfloatev、Fvfloatev32(3fml)、Ffprint、Ffprint32(3fml)、Ffree、Ffree32(3fml)、Fget、Fget32(3fml)、Fgetalloc、Fgetalloc32(3fml)、Fgetlast、Fgetlast32(3fml)、Fgets、Fgets32(3fml)、Fgetsa、Fgetsa32(3fml)、Fidnm_unload、Fidnm_unload32(3fml)、Fidxused、Fidxused32(3fml)、Fielded、Fielded32(3fml)、Findex、Findex32(3fml)、Finit、Finit32(3fml)、Fjoin、Fjoin32(3fml)、Fldid、Fldid32(3fml)、Fldno、Fldno32(3fml)、Fldtype、Fldtype32(3fml)、Flen、Flen32(3fml)、Fmkfldid、Fmkfldid32(3fml)、Fmove、Fmove32(3fml)、Fname、Fname32(3fml)、Fneeded、Fneeded32(3fml)、Fnext、Fnext32(3fml)、Fnmid_unload、Fnmid_unload32(3fml)、Fnum、Fnum32(3fml)、Foccur、Foccur32(3fml)、Fojoin、Fojoin32(3fml)、Fpres、Fpres32(3fml)、Fprint、Fprint32(3fml)、Fproj、Fproj32(3fml)、Fprojcpy、Fprojcpy32(3fml)、Fread、Fread32(3fml)、Frealloc、Frealloc32(3fml)、Frstrindex、Frstrindex32(3fml)、Fsizeof、Fsizeof32(3fml)、Fstrerror、Fstrerror32(3fml)、Ftypcvt、Ftypcvt32(3fml)、Ftype、Ftype32(3fml)、Funindex、Funindex32(3fml)、Funused、Funused32(3fml)、Fupdate、Fupdate32(3fml)、Fused、Fused32(3fml)、Fvall、Fvall32(3fml)、Fvals、Fvals32(3fml)、Fvftos、Fvftos32(3fml)、Fneeded、Fneeded32(3fml)、Fvnull、Fvnull32(3fml)、Fvopt、Fvopt32(3fml)、Fvselinit、Fvselinit32(3fml)、Fvsinit、Fvsinit32(3fml)、Fvstof、Fvstof32(3fml)、Fwrite、Fwrite32(3fml)、field_tables(5)、viewfile(5)

『FMLを使用したTuxedoアプリケーションのプログラミング』

CFadd、CFadd32(3fml)

名前

CFadd()、CFadd32() - フィールドの変換および追加

形式

#include <stdio.h>
#include "fml.h" 
int CFadd(FBFR *fbfr, FLDID fieldid, char *value, FLDLEN len, int type) 
#include fml32.h> 
int 
CFadd32(FBFR32 *fbfr, FLDID32 fieldid, char *value, FLDLEN32 len, int type)

説明

CFadd()は、Fadd()に似た動きをしますが、CFaddは、フィールド化バッファにフィールドが追加される場合、valueをユーザー指定の型からfieldid型に変換します。fbfrは、フィールド化バッファを指すポインタです。fieldidは、フィールド識別子です。valueは、追加される値を指すポインタです。lenは、追加される値の長さです。lenは、FLD_CARRAY型の場合のみ必要です。typeは、value内のフィールドのデータ型です。

フィールドがバッファに追加される前に、データ項目の型が、ユーザー指定の型からfieldidに指定された型に変換されます。ソースがFLD_CARRAY型(任意の文字配列)である場合は、len引数を配列の長さに設定する必要があります。これ以外の場合、長さは無視されます。変換および追加されるフィールドの値は、まず変数valueに設定します。C言語では12345Lのような構成が許可されないためです。

FLD_PTR、FLD_MBSTRING、FLD_FML32、またはFLD_VIEW32のフィールド・タイプが使用されると、この関数は失敗します。CFadd()またはCFadd32()が使用されているとき、これらのフィールド・タイプの1つが指定されると、FerrorにFEBADOPが設定されます。

CFadd32()は32ビットFMLで使用されます。

マルチスレッドのアプリケーション内のスレッドは、TPINVALIDCONTEXTを含め、どのようなコンテキスト状態で実行している場合でも、CFadd()またはCFadd32()を呼び出すことができます。

戻り値

この関数は、エラー発生時に -1を返し、Ferrorを設定してエラー条件を示します。

エラー

次の条件の場合、CFadd()は異常終了し、Ferrorを次の値に設定します。

[FALIGNERR]

[FNOTFLD]

[FMALLOC]

[FEINVAL]

[FNOSPACE]

[FBADFLD]

[FTYPERR]

[FEBADOP]

関連項目

「FML関数の紹介」、Fadd、Fadd32(3fml)

CFchg、CFchg32(3fml)

名前

CFchg()、CFchg32() - フィールドの変換および変更

形式

#include <stdio.h> 
#include "fml.h" 
int CFchg(FBFR *fbfr, FLDID fieldid, FLDOCC oc, char *value, 
       FLDLEN len, int type) 
#include "fml32.h" 
int CFchg32(FBFR32 *fbfr, FLDID32 fieldid, FLDOCC32 oc, 
       char *value,
FLDLEN32 len, int type)

説明

CFchg()は、Fchg()に似た働きをしますが、フィールドがフィールド化バッファにおいて変更されるために、最初に、ユーザー指定のtypeからfieldid型にvalueを変換します。 fbfrは、フィールド化バッファを指すポインタです。 fieldidは、フィールド識別子です。 ocは、フィールドのオカレンス番号です。 valueは、新しい値に対するポインタです。 lenは、変更される値の長さです。lenは、型がFLD_CARRAYの場合のみ必要です。typeはvalueのデータ型です。

存在しないフィールド・オカレンスが指定された場合、必要とされる値が追加されるまで、存在しないオカレンスにNULL値が追加されます(たとえば、バッファに存在しないフィールドのフィールド・オカレンスを4に変更すると、3個のNULL値の後に指定されたフィールド値が追加されます)。

FLD_PTR、FLD_MBSTRING、FLD_FML32、またはFLD_VIEW32のフィールド・タイプが使用されると、この関数は失敗します。CFchg()またはCFchg32()が使用されている場合に、これらのフィールド・タイプの1つが指定されると、FerrorにFEBADOPが設定されます。

CFchg32()は32ビットFMLで使用されます。

マルチスレッドのアプリケーション内のスレッドは、TPINVALIDCONTEXTを含め、どのコンテキスト状態で実行している場合でも、CFchg()またはCFchg32()を呼び出すことができます。

戻り値

この関数は、エラー発生時に -1を返し、Ferrorを設定してエラー条件を示します。

エラー

次の条件の場合、CFchg()は異常終了し、Ferrorを次の値に設定します。

[FALIGNERR]

[FNOTFLD]

[FMALLOC]

[FEINVAL]

[FNOSPACE]

[FNOTPRES]

[FBADFLD]

[FTYPERR]

[FEBADOP]

関連項目

「FML関数の紹介」、CFadd、CFadd32(3fml)、Fchg、Fchg32(3fml)

CFfind、CFfind32(3fml)

名前

CFfind()、CFfind32() - 検索、変換してポインタを返す

形式

#include <stdio.h> 
#include "fml.h" 
char * CFfind(FBFR *fbfr, FLDID fieldid, FLDOCC oc, FLDLEN *len,
  int type) 
#include "fml32.h" 
char * 
CFfind32(FBFR32 *fbfr, FLDID32 fieldid, FLDOCC32 oc, FLDLEN32 *len, 
  int type)

説明

CFfind()は、バッファ内の指定されたフィールドを検索し、それを変換してからその変換した値を指すポインタを返します。fbfrは、フィールド化バッファを指すポインタです。fieldidは、フィールド識別子です。ocはフィールドのオカレンス番号です。lenは、出力時に使用されるもので変換された値の長さを指すポインタです。typeは、ユーザーが変換したいフィールドの変換後のデータ型です。

Ffind()と同じく、この関数で返されるポインタは読取り専用とする必要があります。CFfind()が返すポインタは、次のバッファ操作(破壊的でない場合でも)までしか有効ではありません。これは、変換後の値が1つのプライベート・バッファに保存されているためです。一方、Ffins()の戻り値の場合は、次にバッファが変更されるまで有効です。Ffind()とは異なり、CFfind()は、変換済の値を呼出し側がすぐに使用できるようにします。

FLD_PTR、FLD_MBSTRING、FLD_FML32、またはFLD_VIEW32のフィールド・タイプが使用されると、この関数は失敗します。CFfind()またはCFfind32()が使用されている場合に、これらのフィールド・タイプの1つが指定されると、FerrorにFEBADOPが設定されます。

CFfind32()は32ビットFMLで使用されます。

マルチスレッドのアプリケーション内のスレッドは、TPINVALIDCONTEXTを含め、どのようなコンテキスト状態で実行していても、CFfind()またはCFfind32()を呼び出すことができます。

戻り値

上記の「形式」の項では、CFfind()の戻り値のデータ型は、charポインタ(Cのchar **)として記述されています。実際、戻されるポインタは、格納済のフィールドの型と同じ型を持つオブジェクトを指しています。

この関数は、エラー発生時にNULLを返し、Ferrorを設定してエラー条件を示します。

エラー

次の条件の場合、CFfind()は異常終了し、Ferrorを次の値に設定します。

[FALIGNERR]

[FNOTFLD]

[FMALLOC]

[FNOTPRES]

[FBADFLD]

[FTYPERR]

[FEBADOP]

関連項目

「FML関数の紹介」、Ffind、Ffind32(3fml)

CFfindocc、CFfindocc32(3fml)

名前

CFfindocc()、CFfindocc32() - 変換された値のオカレンスの検索

形式

#include <stdio.h> 
#include "fml.h" 
FLDOCC 
CFfindocc(FBFR *fbfr, FLDID fieldid, char *value, FLDLEN len, int
  type) 
#include "fml32.h" 
FLDOCC32 
CFfindocc32(FBFR32 *fbfr, FLDID32 fieldid, char *value, FLDLEN32
  len, int type)

説明

CFfindocc()の処理はFfindocc()と似ていますが、値をユーザー指定の型からfieldidの型に最初に変換します。CFfindocc()は、ユーザー指定の値、長さおよび型と一致する、指定フィールドをバッファで検索します。CFfindocc()は、最初に一致したフィールドのオカレンス番号を返します。fbfrは、フィールド化バッファを指すポインタです。fieldidは、フィールド識別子です。valueは、検索される値を指すポインタです。型がFLD_CARRAYの場合、lenは、入力値と比較する値の長さです。typeは、value内のフィールドのデータ型です。

FLD_PTR、FLD_MBSTRING、FLD_FML32、またはFLD_VIEW32のフィールド・タイプが使用されると、この関数は失敗します。CFfindocc()またはCFfindocc32()が使用されている場合に、これらのフィールド・タイプの1つが指定されると、FerrorにFEBADOPが設定されます。

CFfindocc32()は32ビットFMLで使用されます。

マルチスレッドのアプリケーション内のスレッドは、TPINVALIDCONTEXTを含め、どのようなコンテキスト状態で実行していても、CFfindocc()またはCFfindocc32()を呼び出すことができます。

戻り値

フィールド値が見つからない場合、または他のエラーが見つかった場合、-1を返し、CFfindocc()はFerrorを設定してエラー条件を示します。

エラー

次の条件の場合、CFfindocc()は異常終了し、Ferrorを次の値に設定します。

[FALIGNERR]

[FNOTFLD]

[FMALLOC]

[FEINVAL]

[FNOTPRES]

[FBADFLD]

[FTYPERR]

[FEBADOP]

関連項目

「FML関数の紹介」、Ffindocc、Ffindocc32(3fml)

CFget、CFget32(3fml)

名前

CFget()、CFget32() - フィールドの取得および変換

形式

#include <stdio.h> 
#include "fml.h" 
int 
CFget(FBFR *fbfr, FLDID fieldid, FLDOCC oc, char *buf, FLDLEN *len,
 int type) 
#include "fml32.h"
int 
CFget32(FBFR32 *fbfr, FLDID32 fieldid, FLDOCC32 oc, char *buf,
 FLDLEN32 *len, int type)

説明

CFget()は、Fget()と同様に変換を行います。変換済の値がユーザー指定バッファにコピーされるのが大きな違いです。fbfrはフィールド化バッファを指すポインタです。fieldidはフィールド識別子です。ocはフィールドのオカレンス番号です。bufはプライベート・データ領域を指すポインタです。入力時においてlenは、プライベート・データ領域の長さを指すポインタです。戻り時においてlenは、返された値の長さを指すポインタです。入力時においてlenパラメータがNULLの場合は、フィールド値を入れるためのバッファが十分大きいために、値の長さが返されないものと想定されます。bufパラメータがNULLの場合、フィールド値は返されません。typeは、ユーザーが変換しようとしている戻り値の変換先のデータ型です。

FLD_PTR、FLD_MBSTRING、FLD_FML32、またはFLD_VIEW32のフィールド・タイプが使用されると、この関数は失敗します。CFget()またはCFget32()が使用されているとき、これらのフィールド・タイプの1つが指定されると、FerrorにFEBADOPが設定されます。

CFget32()は32ビットFMLで使用されます。

マルチスレッドのアプリケーション内のスレッドは、TPINVALIDCONTEXTを含め、どのようなコンテキスト状態で実行していても、CFget()またはCFget32()を呼び出すことができます。

戻り値

この関数は、エラー発生時に -1を返し、Ferrorを設定してエラー条件を示します。

エラー

次の条件の場合、CFget()は異常終了し、Ferrorを次の値に設定します。

[FALIGNERR]

[FNOTFLD]

[FMALLOC]

[FNOSPACE]

[FNOTPRES]

[FBADFLD]

[FTYPERR]

[FEBADOP]

関連項目

「FML関数の紹介」、Fget、Fget32(3fml)

CFgetalloc、CFgetalloc32(3fml)

名前

CFgetalloc()、CFgetalloc32() - フィールドの取得、領域の割り当て、変換

形式

#include <stdio.h> 
#include "fml.h" 
char * 
CFgetalloc(FBFR *fbfr, FLDID fieldid, FLDOCC oc, int type, FLDLEN
 *extralen) 
#include "fml32.h" 
char * 
CFgetalloc32(FBFR32 *fbfr, FLDID32 fieldid, FLDOCC32 oc, int type,
 FLDLEN32 *extralen)

説明

CFgetalloc()は、バッファから指定フィールドを取得し、領域を割り当て、ユーザーが指定した型にフィールドを変換し、その場所を指すポインタを返します。fbfrは、フィールド化バッファを指すポインタです。fieldidはフィールド識別子です。ocはフィールドのオカレンス番号です。typeは、ユーザーが変換しようとしているフィールドの変換先のデータ型です。呼出し時においてextralenは、値を受け取るために割り当てられる追加領域の長さを指すポインタです。戻り時には、extralenは、実際に使用された領域の大きさを指すポインタです。extralenがNULLの場合、割り当てる追加領域はなく、実際の長さは返されません。ユーザーには、(変換された)戻り値を解放する責任があります。

FLD_PTR、FLD_MBSTRING、FLD_FML32、またはFLD_VIEW32のフィールド・タイプが使用されると、この関数は失敗します。CFgetalloc()またはCFgetalloc32()が使用されているとき、これらのフィールド・タイプの1つが指定されると、FerrorにFEBADOPが設定されます。

CFgetalloc32()は32ビットFMLで使用されます。

マルチスレッドのアプリケーション内のスレッドは、TPINVALIDCONTEXTを含め、どのようなコンテキスト状態で実行していても、CFgetalloc()またはCFgetalloc32()を呼び出すことができます。

戻り値

正常終了時には、CFgetalloc()は、変換された値を指すポインタを戻します。エラー時には、NULLを戻し、Ferrorを設定してエラー条件を示します。

エラー

次の条件の場合、CFgetalloc()は異常終了し、Ferrorを次の値に設定します。

[FALIGNERR]

[FNOTFLD]

[FMALLOC]

[FNOTPRES]

[FBADFLD]

[FTYPERR]

[FEBADOP]

関連項目

「FML関数の紹介」、Fgetalloc、Fgetalloc32(3fml)

F_error、F_error32(3fml)

名前

F_error()、F_error32() - 最終エラーのエラー・メッセージを出力

形式

#include stdio.h> 
#include "fml.h" 
extern int Ferror; 
void 
F_error(char *msg) 
#include "fml32.h" 
extern int Ferror32; 
void 
F_error32(char *msg)

説明

この関数F_error()は、UNIXシステム・エラーを出力するperror()に似た働きをします。つまり、標準エラー出力(ファイル記述子2)にエラー・メッセージを作成し、システム・コールあるいはライブラリ関数呼出し時に発生した最後のエラーを記述します。文字列引数msgは、最初に出力されます。次にコロン、空白が出力され、メッセージおよび改行が出力されます。msgがNULLポインタあるいはNULL文字列を指している場合、コロンは出力されません。様々な利用形態を考慮して、この引数文字列には、エラーを起こしたプログラム名を入れます。エラー番号は外部変数Ferrorから取得されます。これはエラーが発生すると設定されますが、エラーではない呼出しが行われてもクリアされません。MS-DOSおよびOS/2環境ではFerrorはFMLerrorに再定義されます。

エラー・メッセージをすぐに出力するには、別のFML関数から返されたエラーに対してF_error()を呼び出す必要があります。エラー・メッセージがFEUNIXのとき、Uunix_err()が呼び出されます。

F_error32()は32ビットFMLで使用されます。

マルチスレッドのアプリケーション内のスレッドは、TPINVALIDCONTEXTを含め、どのコンテキスト状態で実行している場合でも、F_error()またはF_error32()を呼び出すことができます。

戻り値

F_error()は、void宣言なので戻り値はありません。

関連項目

FML関数の紹介

UNIXシステムのリファレンス・マニュアルのperror(3)、Uunix_err(3)

F32to16、F16to32(3fml)

名前

F32to16()、F16to32() - 16ビットFMLバッファと32ビットFMLバッファの間の変換

形式

#include <stdio.h> 
#include "fml.h" 
#include "fml32.h" 
int 
F32to16(FBFR *dest, FBFR32 *src) 
int 
F16to32(FBFR32 *dest, FBFR *src) 

説明

F32to16()は、32ビットのFMLバッファを16ビットのFMLバッファに変換します。これは、フィールド対フィールドのバッファの変換を行い、フィールド化バッファのインデックスを作成することによって行ないます。FLDID32からFLDIDを生成し、フィールド値(文字列、carray、およびmbstringフィールドの長さ)をコピーすることによって、フィールドを変換します。destは、宛先バッファのポインタです。srcは、もとのフィールド化バッファを指すポインタです。ソース・バッファは変更されません。

これらの関数は、領域の不足のために異常終了する場合があります。処理を完了するために十分な追加のメモリーを割り当てた後で、これらの関数を再び呼び出すことができます。

F16to32()は、16ビットのFMLバッファを32ビットのFMLバッファに変換します。この関数は、fml32ライブラリまたは共有オブジェクトに格納されており、エラーが発生するとFerror32が設定されます。

F32to16()は、FMLライブラリまたは共有オブジェクトに格納されており、エラーが発生するとFerrorが設定されます。これらの関数を使用するためには、fml.hおよびfml32.hの両方をインクルードする必要があることに注意してください。同じファイルに、fml1632.hをインクルードする必要はありません。

F32to16()は、FLD_PTR、FLD_MBSTRING、FLD_FML32、またはFLD_VIEW32のフィールド・タイプが使用されると、FBADFLDを設定して異常終了します。これらのフィールド・タイプに対してF16to32()を実行しても、何の影響もありません。

マルチスレッドのアプリケーション内のスレッドは、TPINVALIDCONTEXTを含め、どのようなコンテキスト状態で実行していても、F32to16()またはF16to32()を呼び出すことができます。

戻り値

この関数は、エラー発生時に -1を返し、Ferrorを設定してエラー条件を示します。

エラー

次の条件の場合、F32to16()は異常終了し、Ferrorを次の値に設定します。

[FALIGNERR]

[FNOTFLD]

[FNOSPACE]

[FBADFLD]

関連項目

FML関数の紹介

Fadd、Fadd32(3fml)

名前

Fadd()、Fadd32() - 新しいフィールド・オカレンスの追加

形式

#include stdio.h> 
#include "fml.h" 
int Fadd(FBFR *fbfr, FLDID fieldid, char *value, FLDLEN len) 
#include "fml32.h" 
int Fadd32(FBFR32 *fbfr, FLDID32 fieldid, char *value, FLDLEN32 len)

説明

Fadd()は、指定されたフィールド値を指定されたバッファに追加します。fbfrは、フィールド化バッファを指すポインタです。fieldidは、フィールド識別子です。valueは、新しい値を指すポインタです。したがって、ポインタの型は、追加される値と同じフィールド識別子の型である必要があります。lenは、追加される値の長さです。lenは、FLD_CARRAY型またはFLD_MBSTRING型の場合のみ必要です。

追加する値は、valueパラメータで指される場所にあります。すでに1つまたは複数のフィールド・オカレンスがある場合、新しいフィールド・オカレンスとして値が追加され、現在指定されているオカレンスの最大値より1つ大きいオカレンス番号が割り当てられます(指定されたオカレンスを追加するには、Fchg()を使用する必要があります)。

上記の「形式」の項では、Fadd()の引数valueのデータ型は、charのポインタ(Cのchar *)として記述されています。技術的には、これは、単に、Fadd()に渡せる値のある特定の型を記述しています。実際、引数valueの型は、追加されているフィールドのフィールド化バッファ表現と同じ型のオブジェクトへのポインタにします。たとえば、フィールドが、FLD_LONG型でバッファに格納されている場合は、valueの型は、long型のポインタ(Cのlong *)である必要があります。同様に、FLD_SHORT型でバッファに格納される場合、valueは、short型のポインタ(Cのshort *)である必要があります。大事なことは、Fadd()は、valueが指すオブジェクトが、追加される格納済のフィールドの型と同じ型を持っていることを想定しているということです。

FLD_PTR型の値では、Fadd32()はポインタ値を格納します。FLD_PTRフィールドが指すバッファは、tpalloc()を呼び出して割り当てます。FLD_FML32型の値の場合、Fadd32()は、索引を除くすべてのFLD_FML32フィールドの値を格納します。FLD_VIEW32型の値の場合、Fadd()はFVIEWFLD型の構造体に対するポインタを格納します。FVIEWFLD型の構造体には、vflags (現在未使用で0に設定されているフラグ・フィールド)、vname (VIEW名を含む文字配列)、およびdata (C構造体として格納されるVIEWデータに対するポインタ)が含まれています。アプリケーションは、Fadd32()にvnameとdataを提供します。

FLD_MBSTRING型の値の場合、値はFmbpack32()関数のパッキングされた出力引数であり、引数lenはFmbpack32()の出力引数sizeの値の長さです。

FLD_CARRAY型の値の場合、引数lenは値の長さです。FLD_CARRAYまたはFLD_MBSTRING以外のすべての型では、valueが参照するオブジェクトの長さは、その型から導かれ(たとえば、FLD_FLOATの場合、長さは、sizeof(float)になる)、lenの内容は無視されます。

Fadd32は32ビットFMLで使用されます。

マルチスレッドのアプリケーション内のスレッドは、TPINVALIDCONTEXTを含め、どのようなコンテキスト状態で実行していても、Fadd()またはFadd32()を呼び出すことができます。

戻り値

この関数は、エラー発生時に -1を返し、Ferrorを設定してエラー条件を示します。

エラー

次の条件の場合、Fadd()は異常終了し、Ferrorを次の値に設定します。

[FALIGNERR]

[FNOTFLD]

[FEINVAL]

[FNOSPACE]

[FBADFLD]

関連項目

「FML関数の紹介」、CFadd、CFadd32(3fml)、Fadds、Fadds32(3fml)、Fchg、Fchg32(3fml)

Fadds、Fadds32(3fml)

名前

Fadds()、Fadds32() - FLD_STRING型の値を変換し、バッファに追加

形式

#include <stdio.h> 
#include "fml.h" 
int 
Fadds(FBFR *fbfr, FLDID fieldid, char *value) 
#include "fml32.h" 
int 
Fadds32(FBFR32 *fbfr, FLDID32 fieldid, char *value)

説明

Fadds()は、ユーザー型FLD_STRINGからフィールド型(fieldid)への変換を処理し、それをフィールド化バッファに追加するために提供されています。fbfrは、フィールド化バッファを指すポインタです。fieldidは、フィールド識別子です。valueは、追加される値を指すポインタです。

この関数は、type (FLD_STRING)を提供し、lenが0であるCFadd()を呼び出します。

Fadds32()は32ビットFMLで使用されます。

マルチスレッドのアプリケーション内のスレッドは、TPINVALIDCONTEXTを含め、どのようなコンテキスト状態で実行していても、Fadds()またはFadds32()を呼び出すことができます。

戻り値

この関数は、エラー発生時に -1を返し、Ferrorを設定してエラー条件を示します。

エラー

次の条件の場合、Fadds()は異常終了し、Ferrorを次の値に設定します。

[FALIGNERR]

[FNOTFLD]

[FNOSPACE]

[FTYPERR]

[FEINVAL]

[FMALLOC]

[FBADFLD]

関連項目

「FML関数の紹介」、CFchg、CFchg32(3fml)、CFfind、CFfind32(3fml)、CFget、CFget32(3fml)、Falloc、Falloc32(3fml)、Fchgs、Fchgs32(3fml)、Ffinds、Ffinds32(3fml)、Fgets、Fgets32(3fml)、Fgetsa、Fgetsa32(3fml)

Falloc、Falloc32(3fml)

名前

Falloc()、Falloc32() - フィールド化バッファの割り当ておよび初期化

形式

#include <stdio.h> 
#include "fml.h" 
FBFR * 
Falloc(FLDOCC F, FLDLEN V) 
#include "fml32.h" 
FBFR32 * 
Falloc32(FLDOCC32 F, FLDLEN32 V)

説明

Falloc()は、フィールド化バッファ用に、malloc()を使用して領域を動的に割り当て、Finit()を呼び出してそれを初期化します。パラメータには、バッファに格納されているすべてのフィールドについて、フィールド数(F)および値の領域のバイト数(V)があります。

Falloc32()は、より多くのフィールドを持つ大きなバッファのために使用されます。

マルチスレッドのアプリケーション内のスレッドは、TPINVALIDCONTEXTを含め、どのようなコンテキスト状態で実行していても、Falloc()またはFalloc32()を呼び出すことができます。

戻り値

この関数は、エラー発生時にNULLを返し、Ferrorを設定してエラー条件を示します。

エラー

次の条件の場合、Falloc()は異常終了し、Ferrorを次の値に設定します。

[FMALLOC]

[FEINVAL]

関連項目

「FML関数の紹介」、Ffree、Ffree32(3fml)、Fielded、Fielded32(3fml)、Finit、Finit32(3fml)、Fneeded、Fneeded32(3fml)、Frealloc、Frealloc32(3fml)、Fsizeof、Fsizeof32(3fml)、Funused、Funused32(3fml)

UNIXシステムのリファレンス・マニュアルのmalloc(3)

Fappend、Fappend32(3fml)

名前

Fappend()、Fappend32() - 新しいフィールド・オカレンスの追加

形式

#include <stdio.h>
#include "fml.h" 
int 
Fappend(FBFR *fbfr, FLDID fieldid, char *value, FLDLEN len)
#include "fml32.h" 
int 
Fappend32(FBFR32 *fbfr, FLDID32 fieldid, char *value, FLDLEN32 len) 

説明

Fappend()は、指定されたフィールド値を指定されたバッファの終わりに追加します。Fappend()は、汎用目的のFMLアクセスに必要な内部構造体および順序付けを保持しない、大規模なバッファを作成する際に役に立ちます。この最適化の影響として、Fappend()への呼出しの後には、Fappend()への追加の呼び出し、FML索引ルーチンFindex()およびFunindex()への呼び出し、またはFree()、Fused()、Funused()、Fsizeof()への呼び出ししか行なえません。Findex()またはFunindex()を呼び出す前に他のFMLルーチンへの呼出しを行うと、FerrorがFNOTFLDに設定されてエラーが発生します。

fbfrは、フィールド化バッファを指すポインタです。fieldidは、フィールド識別子です。valueは、新しい値を指すポインタです。したがって、ポインタの型は、追加される値と同じフィールド識別子の型である必要があります。lenは、追加される値の長さです。lenは、FLD_CARRAY型またはFLD_MBSTRING型の場合のみ必要です。

追加する値は、valueパラメータで指される場所にあります。すでに1つまたは複数のフィールド・オカレンスがある場合、新しいフィールド・オカレンスとして値が追加され、現在指定されているオカレンスの最大値より1つ大きいオカレンス番号が割り当てられます(指定されたオカレンスを追加するには、Fchg()を使用する必要があります)。

上記の「形式」の項では、Fappend()の引数valueのデータ型は、charのポインタ(Cのchar *)として記述されています。技術的には、これは、単に、Fappend()に渡せる値の1つの特定の型を記述しています。実際、引数valueの型は、追加されているフィールドのフィールド化バッファ表現と同じ型のオブジェクトのポインタである必要があります。たとえば、フィールドが、FLD_LONG型でバッファに格納されている場合は、valueの型は、long型のポインタ(Cのlong *)である必要があります。同様に、FLD_SHORT型でバッファに格納される場合、valueは、short型のポインタ(Cのshort *)である必要があります。重要なことは、Fappend()は、valueが指すオブジェクトが、追加される格納済のフィールドと同じ型を持っていると想定しているということです。

FLD_MBSTRING型の値の場合、値はFmbpack32()関数のパッキングされた出力引数であり、引数lenはFmbpack32()の出力引数sizeの値の長さです。

FLD_CARRAY型の値の場合、引数lenは値の長さです。FLD_CARRAYまたはFLD_MBSTRING以外のすべての型では、valueが参照するオブジェクトの長さは、その型から導かれ(たとえば、FLD_FLOATの場合、長さは、sizeof(float)になる)、lenの内容は無視されます。

Fappend32()は32ビットFMLで使用されます。

マルチスレッドのアプリケーション内のスレッドは、TPINVALIDCONTEXTを含め、どのようなコンテキスト状態で実行していても、Fappend()またはFappend32()を呼び出すことができます。

戻り値

この関数は、エラー発生時に -1を返し、Ferrorを設定してエラー条件を示します。

エラー

次の条件の場合、Fappend()は異常終了し、Ferrorを次の値に設定します。

[FALIGNERR]

[FNOTFLD]

[FEINVAL]

[FNOSPACE]

[FBADFLD]

関連項目

「FML関数の紹介」、Fadd、Fadd32(3fml)、Ffree、Ffree32(3fml)、Findex、Findex32(3fml)、Fsizeof、Fsizeof32(3fml)、Funindex、Funindex32(3fml)、Funused、Funused32(3fml)、Fused、Fused32(3fml)

Fboolco、Fboolco32、Fvboolco、Fvboolco32(3fml)

名前

Fboolco()、Fboolco32()、Fvboolco()、Fvboolco32() - 式をコンパイルし評価ツリーを返す

形式

#include <stdio.h> 
#include "fml.h" 
char * 
Fboolco(char *expression) 
char * 
Fvboolco(char *expression, char *viewname) 
#include "fml32.h" 
char * 
Fboolco32(char *expression) 
char * 
Fvboolco32(char *expression, char *viewname)

説明

Fboolco()は、expressionが指す論理表現をコンパイルし、評価ツリーのポインタを返します。認識される表現は、Cで認識される表現に近いものです。文法の説明は、『FMLを使用したOracle Tuxedoアプリケーションのプログラミング』に記載されています。

Fboolco()が作成する評価ツリーは、下記の「関連項目」の項でリストされている他の論理関数に使用されます。したがって、式を再びコンパイルする必要はありません。

Fboolco32()は32ビットFMLで使用されます。

Fvboolco()およびFvboolco32()は、同じVIEW機能を提供します。viewnameパラメータは、フィールド・オフセットを取り出すVIEWを示します。

FLD_PTR、FLD_MBSTRING、FLD_FML32、またはFLD_VIEW32のフィールド・タイプが使用されると、この関数は失敗します。これらのフィールド・タイプの1つが指定されると、FerrorにFEBADOPが設定されます。

Workstationプラットフォームでは、これらの関数はサポートされていません。

マルチスレッドのアプリケーション内のスレッドは、TPINVALIDCONTEXTを含め、どのようなコンテキスト状態で実行していても、ここで記述する関数、Fboolco()、Fboolco32()、Fvboolco()、またはFvboolco32()を呼び出すことができます。

戻り値

この関数は、エラー発生時にNULLを返し、Ferrorを設定してエラー条件を示します。

エラー

次の条件の場合、Fboolco()は異常終了し、Ferrorを次の値に設定します。

[FMALLOC]

[FSYNTAX]

[FBADNAME]

[FEINVAL]

[FBADVIEW]

[FVFOPEN]

[EUNIX]

[FVFSYNTAX]

[FMALLOC]

[FEBADOP]

例

#include "stdio.h" 
#include "fml.h" 
extern char *Fboolco(\|); 
char *tree; 
... 
if((tree=Fboolco("FIRSTNAME %% 'J.*n' & SEX = 'M'")) == NULL)
 F_error("pgm_name");

この例では、'J'で始まり'n'で終わる(たとえば、John、Jean、Jurgenなど) FIRSTNAMEフィールドがバッファにあるか、SEXフィールドが'M'に等しいかを検査する論理表現をコンパイルします。

tree配列の最初の文字は、最下位バイトを形成します。次の文字は、最上位バイトを形成します。それぞれ、全体の配列の長さをバイト数で指定する符号なし型(16ビット)です。この値は、複写あるいは配列の操作に役立ちます。

関連項目

Fboolev、Fboolev32、Fvboolev、Fvboolev32(3fml)、Fboolpr、Fboolpr32、Fvboolpr、Fvboolpr32(3fml)、Fldid、Fldid32(3fml)

Fboolev、Fboolev32、Fvboolev、Fvboolev32(3fml)

名前

Fboolev()、Fboolev32()、Fvboolev()、Fvboolev32() - 評価ツリーに対するバッファの評価

形式

#include stdio.h> 
#include "fml.h" 
int 
Fboolev(FBFR *fbfr, char *tree) 
int 
Fvboolev(char *cstruct, char *tree, char *viewname) 
#include "fml32.h" 
int 
Fboolev32(FBFR32 *fbfr, char *tree) 
int 
Fvboolev32(char *cstruct, char *tree, char *viewname)

説明

Fboolev()は、フィールド化バッファを指すポインタ(fbfr)、Fboolco()が戻す評価ツリーのポインタ(tree)を利用して、フィールド化バッファが指定された論理条件と一致する場合は、true (1)を戻し、そうでない場合はfalse (0)を戻します。この関数は、フィールド化バッファあるいは評価ツリーのいずれも変更しません。評価ツリーは、Fboolco()によって以前コンパイルされたものです。

Fboolev32()は32ビットFMLで使用されます。

Fvboolev()およびFvboolev32()は、同じVIEW機能を提供します。viewnameパラメータは、フィールド・オフセットを取り出すVIEWを示し、Fvboolco()またはFvboolco32()で指定されたVIEWと同じにする必要があります。

Workstationプラットフォームでは、これらの関数はサポートされていません。

マルチスレッドのアプリケーション内のスレッドは、TPINVALIDCONTEXTを含め、どのようなコンテキスト状態で実行していても、ここで記述する関数、Fboolev()、Fboolev32()、Fvboolev()、またはFvboolev32()を呼び出すことができます。

戻り値

Fboolev()は、バッファ内の表現と評価ツリーが一致している場合、1を戻します。表現が評価ツリーと不一致の場合、0を戻します。この関数は、エラー発生時に-1を戻し、Ferrorを設定してエラー条件を示します。

エラー

次の条件の場合、Fboolev()は異常終了し、Ferrorを次の値に設定します。

[FALIGNERR]

[FNOTFLD]

[FMALLOC]

[FEINVAL]

[FSYNTAX]

[FBADVIEW]

[FVFOPEN]

[EUNIX]

[FVFSYNTAX]

[FMALLOC]

例

Fboolco()の使用例でコンパイルした評価ツリーを使用します。

#include stdio.h> 
#include "fml.h" 
#include "fld.tbl.h" 
FBFR *fbfr; 
... 
Fchg(fbfr,FIRSTNAME,0,"John",0); 
Fchg(fbfr,SEX,0,"M",0); 
if(Fboolev(fbfr,tree) > 0)
 fprintf(stderr,"Buffer selected\\\\n"); 
else
 fprintf(stderr,"Buffer not selected\\\\n");

Buffer selectedを出力します。

関連項目

「FML関数の紹介」、Fboolco、Fboolco32、Fvboolco、Fvboolco32(3fml)、Fboolpr、Fboolpr32、Fvboolpr、Fvboolpr32(3fml)

Fboolpr、Fboolpr32、Fvboolpr、Fvboolpr32(3fml)

名前

Fboolpr()、Fboolpr32()、Fvboolpr()、Fvboolpr32() - パースされた論理式を出力

形式

#include <stdio.h> 
#include "fml.h" 
void 
Fboolpr(char *tree, FILE *iop) 
int 
Fvboolpr(char *tree, FILE *iop, char *viewname) 
#include "fml32.h" 
void 
Fboolpr32(char *tree, FILE *iop) 
int 
Fvboolpr32(char *tree, FILE *iop, char *viewname)

説明

Fboolpr()は、コンパイル済の表現を指定された出力ストリームに出力します。評価ツリー(tree)は、Fboolco()で以前作成されたものです。iopは、出力ストリームを指すFILE型のポインタです。出力内容のすべてがかっこ内に入れられ、評価ツリーで示されるように解析されます。この関数はデバッグに役立ちます。

Fboolpr32()は32ビットFMLで使用されます。

Fvboolpr()およびFvboolpr32()は、同じVIEW機能を提供します。viewnameパラメータは、フィールド・オフセットを取り出すVIEWを示し、Fvboolco()またはFvboolco32()で指定されたVIEWと同じにする必要があります。

Workstationプラットフォームでは、これらの関数はサポートされていません。

マルチスレッドのアプリケーション内のスレッドは、TPINVALIDCONTEXTを含め、どのようなコンテキスト状態で実行していても、ここで記述する関数、Fboolpr()、Fboolpr32()、Fvboolpr()、またはFvboolpr32()を呼び出すことができます。

戻り値

Fboolpr()は、voidを戻すものとして宣言されているので、戻り値はありません。Fvboolpr()は、VIEW名が無効な場合は-1を戻します。

エラー

次の条件の場合、Fvboolpr()は失敗し、Ferrorを次の値に設定します。

[FBADVIEW]

[FVFOPEN]

[EUNIX]

[FVFSYNTAX]

[FMALLOC]

移植性

この関数は、Windows用のOracle Tuxedo System Workstation DLLでは使用できません。

関連項目

「FML関数の紹介」、Fboolco、Fboolco32、Fvboolco、Fvboolco32(3fml)

Fchg、Fchg32(3fml)

名前

Fchg()、Fchg32() - フィールド・オカレンス値を変更

形式

#include <stdio.h> 
#include "fml.h" 
int 
Fchg(FBFR *fbfr, FLDID fieldid, FLDOCC oc, char *value, FLDLEN len)
#include "fml32.h" 
int 
Fchg32(FBFR32 *fbfr, FLDID32 fieldid, FLDOCC32 oc, char *value,
 FLDLEN32 len)

説明

Fchg()は、バッファ内のフィールド値を変更します。fbfrは、フィールド化バッファを指すポインタです。fieldidは、フィールド識別子です。ocはフィールドのオカレンス番号です。valueは、新しい値を指すポインタです。したがって、その型は、変更される値と同じ型である必要があります(下記参照)。lenは、変更される値の長さです。lenは、FLD_CARRAY型またはFLD_MBSTRING型の場合のみ必要です。

オカレンスが-1と指定された場合、フィールド値が新しいオカレンスとしてバッファに追加されます。指定されたフィールド・オカレンスが見つかった場合、フィールド値は、指定された値に変更されます。存在しないフィールド・オカレンスが指定された場合、必要とするオカレンスが追加されるまで、見つからないオカレンス用にはNULL値が追加されます(たとえば、バッファに存在しないフィールド用にフィールド・オカレンスを4に変更すると、3個のNULL値の後に指定されたフィールド値が追加されます)。NULL値については、文字列型と文字型の値の場合はNULL文字列(長さ1バイト)、long型とshort型のフィールドの場合は0、float型とdouble型の値の場合は0.0、文字配列の場合は0長の文字列が使用されます。新しい値または変更された値がvalueに含まれ、文字配列の場合、その長さをlenに指定します(それ以外の場合は無視されます)。valueがNULLの場合、フィールド・オカレンスは削除されます。削除する値が見つからない場合、エラーと見なされます。

上記の「形式」の項では、Fchg()の引数valueのデータ型は、charのポインタ(Cのchar *)として記述されています。技術的には、Fchg()に渡されるある1つの特別な種類の値のみ記述しています。実際、引数valueの型は、変更するフィールドのフィールド化バッファの表現の型と同じ型のオブジェクトを指すポインタでなければなりません。たとえば、フィールドが、FLD_LONG型でバッファに格納されている場合は、valueの型は、long型のポインタ(Cのlong *)である必要があります。同様に、FLD_SHORT型でバッファに格納される場合、valueは、short型のポインタ(Cのshort *)である必要があります。大事なことは、Fchg()は、valueが指すオブジェクトが、変更される格納済のフィールドの型と同じ型を持っていると想定していることです。

FLD_PTR型の値では、Fchg32()はポインタ値を格納します。FLD_PTRフィールドが指すバッファは、tpalloc()を呼び出して割り当てます。FLD_FML32型の値の場合、Fchg32()は、索引を除くすべてのFLD_FML32フィールドの値を格納します。FLD_VIEW32型の値の場合、Fchg()はFVIEWFLD型の構造体に対するポインタを格納します。FVIEWFLD型の構造体には、vflags (現在未使用で0に設定されているフラグ・フィールド)、vname (VIEW名を含む文字配列)、およびdata (C構造体として格納されるVIEWデータに対するポインタ)が含まれています。アプリケーションは、vnameとdataをFchg32()に提供します。

FLD_MBSTRING型の値の場合、値はFmbpack32()関数のパッキングされた出力引数であり、引数lenはFmbpack32()の出力引数sizeの値の長さです。

FLD_CARRAY型の値の場合、引数lenは値の長さです。FLD_CARRAYまたはFLD_MBSTRING以外のすべての型では、valueが参照するオブジェクトの長さは、その型から導かれ(たとえば、FLD_FLOATの場合、長さは、sizeof(float)になる)、lenの内容は無視されます。

Fchg32()は32ビットFMLで使用されます。

マルチスレッドのアプリケーション内のスレッドは、TPINVALIDCONTEXTを含め、どのコンテキスト状態で実行している場合でも、Fchg()またはFchg32()を呼び出すことができます。

戻り値

この関数は、エラー発生時に -1を返し、Ferrorを設定してエラー条件を示します。

エラー

次の条件の場合、Fchg()は失敗し、Ferrorを次の値に設定します。

[FALIGNERR]

[FNOTFLD]

[FNOTPRES]

[FNOSPACE]

[FBADFLD]

関連項目

「FML関数の紹介」、CFchg、CFchg32(3fml)、Fadd、Fadd32(3fml)、Fcmp、Fcmp32(3fml)、Fdel、Fdel32(3fml)

Fchgs、Fchgs32(3fml)

名前

Fchgs()、Fchgs32() - フィールド・オカレンスの変更 - 呼出し側は、文字列を提供

形式

#include <stdio.h> 
#include "fml.h" 
int 
Fchgs(FBFR *fbfr, FLDID fieldid, FLDOCC oc, char *value)  
#include "fml32.h" 
int 
Fchgs32(FBFR32 *fbfr, FLDID32 fieldid, int oc, char *value)

説明

Fchgs()は、ユーザー型FLD_STRINGの変換を処理のために提供されています。fbfrは、フィールド化バッファを指すポインタです。fieldidは、フィールド識別子です。ocはフィールドのオカレンス番号です。valueは、追加される文字列を指すポインタです。この関数は、文字列をfieldidのフィールド・タイプに変換するためのFLD_STRING型およびlen (値が0)を設定して非文字列関数CFchg()を呼び出します。

Fchgs32()は32ビットFMLで使用されます。

マルチスレッドのアプリケーション内のスレッドは、TPINVALIDCONTEXTを含め、どのコンテキスト状態で実行している場合でも、Fchgs()またはFchgs32()を呼び出すことができます。

戻り値

この関数は、エラー発生時に -1を返し、Ferrorを設定してエラー条件を示します。

エラー

次の条件の場合、Fchgs()は異常終了し、Ferrorを次の値に設定します。

[FALIGNERR]

[FNOTFLD]

[FNOSPACE]

[FBADFLD]

[FTYPERR]

関連項目

「FML関数の紹介」、CFchg、CFchg32(3fml)、Fchg、Fchg32(3fml)

Fchksum、Fchksum32(3fml)

名前

Fchksum()、Fchksum32() - フィールド化バッファのチェックサムの計算

形式

#include <stdio.h> 
#include "fml.h" 
long 
Fchksum(FBFR *fbfr) 
#include "fml32.h" 
long 
Fchksum32(FBFR32 *fbfr)

説明

高信頼性のI/Oでは、チェックサムは、Fchksum()を使用して計算され、書き込まれているフィールド化バッファに格納されます。fbfrは、フィールド化バッファを指すポインタです。格納されたチェックサムは、すべてのバッファを受信したことを確かめるために、受信プロセスによって検査されます。

FLD_PTR型の値の場合、ポインタまたはポインタによって参照されるデータのかわりに、ポインタのフィールドの名前がチェックサム計算に含まれます。

Fchksum32()は32ビットFMLで使用されます。

マルチスレッドのアプリケーション内のスレッドは、TPINVALIDCONTEXTを含め、どのコンテキスト状態で実行している場合でも、Fchksum()またはFchksum32()を呼び出すことができます。

戻り値

正常終了の場合、Fchksum()はチェックサムを戻します。この関数は、エラー発生時に-1を戻し、Ferrorを設定してエラー条件を示します。

エラー

次の条件の場合、Fchksum()は異常終了し、Ferrorを次の値に設定します。

[FALIGNERR]

[FNOTFLD]

関連項目

「FML関数の紹介」、Fread、Fread32(3fml)、Fwrite、Fwrite32(3fml)

Fcmp、Fcmp32(3fml)

名前

Fcmp()、Fcmp32() - 2つのフィールド化バッファの比較

形式

#include <stdio.h> 
#include "fml.h" 
int 
Fcmp(FBFR *fbfr1, FBFR *fbfr2) 
#include "fml32.h" 
int 
Fcmp32(FBFR32 *fbfr1, FBFR32 *fbfr2)

説明

Fcmp()は、フィールド識別子を比較してから、2つのFMLバッファのフィールド値を比較します。fbfr1およびfbfr2は、比較するフィールド化バッファを指すポインタです。

FLD_PTR型の値の場合、ポインタの値(アドレス)が等しければ、2つのポインタ・フィールドは等しいとみなされます。FLD_FML32型の値の場合、すべてのフィールド・オカレンスおよび値が等しければ、2つのフィールドは等しいとみなされます。FLD_VIEW32型の値の場合、VIEW名が同じとき、およびすべての構造体メンバーのオカレンスおよび値が等しいとき、2つのフィールドは等しいとみなされます。

Fcmp32()は32ビットFMLで使用されます。

マルチスレッドのアプリケーション内のスレッドは、TPINVALIDCONTEXTを含め、どのコンテキスト状態で実行している場合でも、Fcmp()またはFcmp32()を呼び出すことができます。

戻り値

この関数は、2つのバッファが等しい場合には0を戻します。次に示す条件の場合-1を戻します。

条件のいずれかに該当する場合(たとえば、fbfr1フィールドのfieldidが対応するフィールドfbfr2のfieldidより大きい場合)、Fcmp()は1を返します。バッファの実際のサイズ(Falloc()に渡されるサイズ)は考慮されません。バッファのデータのみです。この関数は、エラー発生時に-2を戻し、Ferrorを設定してエラー条件を示します。

エラー

次の条件の場合、Fcmp()は異常終了し、Ferrorを次の値に設定します。

[FALIGNERR]

[FNOTFLD]

関連項目

「FML関数の紹介」、Fadd、Fadd32(3fml)、Fchg、Fchg32(3fml)

Fconcat、Fconcat32(3fml)

名前

Fconcat()、Fconcat32() - ソース・バッファと宛先バッファの連結

形式

#include <stdio.h> 
#include "fml.h" 
int 
Fconcat(FBFR *dest, FBFR *src) 
#include "fml32.h" 
int 
Fconcat32(FBFR32 *dest, FBFR32 *src)

説明

Fconcat()は、ソース・バッファのフィールドを、すでにある宛先バッファにあるフィールドに追加します。destは、宛先バッファのポインタです。srcは、元のフィールド化バッファを指すポインタです。宛先バッファにあるオカレンスは維持され、ソース・バッファの新しいオカレンスは、フィールドに対して比較的大きなオカレンス番号で追加されます。

Fconcat32()は32ビットFMLで使用されます。

マルチスレッドのアプリケーション内のスレッドは、TPINVALIDCONTEXTを含め、どのようなコンテキスト状態で実行していても、Fconcat()またはFconcat32()を呼び出すことができます。

戻り値

この関数は、エラー発生時に -1を返し、Ferrorを設定してエラー条件を示します。

エラー

次の条件の場合、Fconcat()は異常終了し、Ferrorを次の値に設定します。

[FALIGNERR]

[FNOTFLD]

[FNOSPACE]

関連項目

「FML関数の紹介」、Fjoin、Fjoin32(3fml)、Fupdate、Fupdate32(3fml)

Fcpy、Fcpy32(3fml)

名前

Fcpy()、Fcpy32() - ソース・バッファを宛先バッファにコピー

形式

#include <stdio.h> 
#include "fml.h" 
int 
Fcpy(FBFR *dest, FBFR *src) 
#include "fml32.h" 
int 
Fcpy32(FBFR32 *dest, FBFR32 *src)

説明

Fcpy()は、フィールド化バッファの内容を別のフィールド化バッファにコピーするために使用されます。destおよびsrcは、それぞれコピー先とコピー元のフィールド化バッファに対するポインタです。Fcpy()は、コピー先がフィールド化バッファであると想定して、コピー元バッファのデータを収容できる十分な大きさがあるかをチェックします。

FLD_PTR型の値の場合、Fcpy32()はバッファのポインタをコピーします。アプリケーション・プログラマは、対応するポインタがコピーされたときのバッファの再割り当ておよび解放を管理する必要があります。

Fcpy32()は32ビットFMLで使用されます。

マルチスレッドのアプリケーション内のスレッドは、TPINVALIDCONTEXTを含め、どのコンテキスト状態で実行している場合でも、Fcpy()またはFcpy32()を呼び出すことができます。

戻り値

この関数は、エラー発生時に -1を返し、Ferrorを設定してエラー条件を示します。

エラー

次の条件の場合、Fcpy()は異常終了し、Ferrorを次の値に設定します。

[FALIGNERR]

[FNOTFLD]

[FNOSPACE]

関連項目

「FML関数の紹介」、Fmove、Fmove32(3fml)

Fdel、Fdel32(3fml)

名前

Fdel()、Fdel32() - バッファからフィールド・オカレンスを削除

形式

#include stdio.h> 
#include "fml.h" 
int 
Fdel(FBFR *fbfr, FLDID fieldid, FLDOCC oc) 
#include "fml32.h" 
int 
Fdel32(FBFR32 *fbfr, FLDID32 fieldid, FLDOCC32 oc)

説明

Fdel()は、指定されたフィールド・オカレンスをバッファから削除します。fbfrは、フィールド化バッファを指すポインタです。fieldidは、フィールド識別子です。ocはフィールドのオカレンス番号です。

フィールド化バッファに、1つのフィールドに対し複数のオカレンスがあり、最後のオカレンスでないフィールド・オカレンスが削除された場合、バッファにある高位のオカレンスは、1つずつ繰り下がります。すべてのオカレンスのオカレンス番号を同じままにするためには、Fchg()を使用してフィールド・オカレンス値をNULLに設定します。

FLD_PTR型の値の場合、Fdel32()によってFLD_PTRフィールド・オカレンスが削除されても、参照されるバッファは変更されないか、またはポインタは解放されません。データ・バッファは、非透過的なポインタとして扱われます。

Fdel32()は32ビットFMLで使用されます。

マルチスレッドのアプリケーション内のスレッドは、TPINVALIDCONTEXTを含め、どのコンテキスト状態で実行している場合でも、Fdel()またはFdel32()を呼び出すことができます。

戻り値

この関数は、エラー発生時に -1を返し、Ferrorを設定してエラー条件を示します。

エラー

次の条件の場合、Fdel()は異常終了し、Ferrorを次の値に設定します。

[FALIGNERR]

[FNOTFLD]

[FNOTPRES]

[FBADFLD]

関連項目

「FML関数の紹介」、Fadd、Fadd32(3fml)、Fchg、Fchg32(3fml)、Fdelall、Fdelall32(3fml)、Fdelete、Fdelete32(3fml)

Fdelall、Fdelall32(3fml)

名前

Fdelall()、Fdelall32() - バッファからすべてのフィールド・オカレンスを削除

形式

#include <stdio.h> 
#include "fml.h" 
int 
Fdelall(FBFR *fbfr, FLDID fieldid) 
#include "fml32.h" 
int 
Fdelall32(FBFR32 *fbfr, FLDID32 fieldid)

説明

Fdelall()は、バッファにある指定されたフィールドのすべてのオカレンスを削除します。fbfrは、フィールド化バッファを指すポインタです。fieldidは、フィールド識別子です。フィールドのオカレンスがない場合は、エラーと見なされます。

FLD_PTR型の値の場合、Fdelall32()によってFLD_PTRフィールド・オカレンスが削除されても、参照されるバッファは変更されないか、またはポインタは解放されません。データ・バッファは、非透過的なポインタとして扱われます。

Fdelall32()は32ビットFMLで使用されます。

マルチスレッドのアプリケーション内のスレッドは、TPINVALIDCONTEXTを含め、どのコンテキスト状態で実行している場合でも、Fdelall()またはFdelall32()を呼び出すことができます。

戻り値

この関数は、エラー発生時に -1を返し、Ferrorを設定してエラー条件を示します。

エラー

次の条件の場合、Fdelall()は異常終了し、Ferrorを次の値に設定します。

[FALIGNERR]

[FNOTFLD]

[FNOTPRES]

[FBADFLD]

関連項目

「FML関数の紹介」、Fdel、Fdel32(3fml)、Fdelete、Fdelete32(3fml)

Fdelete、Fdelete32(3fml)

名前

Fdelete()、Fdelete32() - バッファからフィールドのリストを削除

形式

#include <stdio.h>  
#include "fml.h"  
int  
Fdelete(FBFR *fbfr, FLDID *fieldid)  
#include "fml32.h"  
int  
Fdelete32(FBFR32 *fbfr, FLDID32 *fieldid)

説明

Fdelete()は、フィールド識別子の配列(fieldid[])にリストされているすべてのフィールドのすべてのオカレンスを削除します。配列の最後のエントリはBADFLDIDであることが必要です。fbfrはフィールド化バッファを指すポインタです。fieldidはフィールド識別子の配列を指すポインタです。これは、Fdelall()の呼出しを繰り返すよりも、バッファから複数のフィールドを削除する効率のよい方法です。更新はその場で実行されます。フィールド識別子の配列は、Fdelete()によって再配列されます(ソートされていない場合はソートされ、番号順になります)。

FLD_PTR型の値の場合、Fdelete32()によってFLD_PTRフィールド・オカレンスが削除されても、参照されるバッファは変更されないか、またはポインタは解放されません。データ・バッファは、非透過的なポインタとして扱われます。

Fdelete()は、削除するフィールドがフィールド化バッファにない場合も正常終了で返ります。

Fdelete32()は32ビットFMLで使用されます。

マルチスレッドのアプリケーション内のスレッドは、TPINVALIDCONTEXTを含め、どのコンテキスト状態で実行している場合でも、Fdelete()またはFdelete32()を呼び出すことができます。

戻り値

この関数は、エラー発生時に -1を返し、Ferrorを設定してエラー条件を示します。

エラー

次の条件の場合、Fdelete()は異常終了し、Ferrorを次の値に設定します。

[FALIGNERR]

[FNOTFLD]

[FBADFLD]

関連項目

「FML関数の紹介」、Fdel、Fdel32(3fml)、Fdelall、Fdelall32(3fml)

Fextread、Fextread32(3fml)

名前

Fextread()、Fextread32() - フォーマットされた出力からフィールド化バッファを作成

形式

#include <stdio.h>  
#include "fml.h"  
int  
Fextread(FBFR *fbfr, FILE *iop)  
#include "fml32.h"  
int  
Fextread32(FBFR32 *fbfr, FILE *iop)

説明

Fextread()は、フォーマットされた出力(つまり、Fprint()の出力)からフィールド化バッファを作成するために使用されます。パラメータは、フィールド化バッファを指すポインタfbfrとファイル・ストリームを指すポインタiopです。入力ファイル形式は基本的にFprint()の出力形式と同じで、次のようになります。

[flag] fldname or fldid tab> fldval (or fldname, if flag is ``='')

選択フラグおよびそれらの意味を次に示します。

+

-

=

#

フラグが指定されない場合、値(fldval)を持ったfldnameで指定されているフィールドの新しいオカレンスが、フィールド化バッファに追加されます。後続の改行(-)は、完了済の各入力バッファの後に置く必要があります。

FLD_FML32およびFLD_VIEW32型の値の場合、Fextread32()はそれぞれ、ネストされたFML32バッファとVIEW32フィールドを生成します。この関数は、FLD_PTRフィールド・タイプを無視します。関数にタイプFLD_PTRの値が与えられても、エラーは戻されません。

Fextread32()は32ビットFMLで使用されます。

マルチスレッドのアプリケーション内のスレッドは、TPINVALIDCONTEXTを含め、どのようなコンテキスト状態で実行していても、Fextread()またはFextread32()を呼び出すことができます。

戻り値

この関数は、エラー発生時に -1を返し、Ferrorを設定してエラー条件を示します。

エラー

次の条件の場合、Fextread()は異常終了し、Ferrorを次の値に設定します。

[FALIGNERR]

[FNOTFLD]

[FNOSPACE]

[FBADFLD]

[FEUNIX]

[FBADNAME]

[FSYNTAX]

[FNOTPRES]

[FMALLOC]

[FEINVAL]

移植性

この関数は、Windows用のOracle Tuxedo System Workstation DLLでは使用できません。

関連項目

「FML関数の紹介」、Fprint、Fprint32(3fml)

Ffind、Ffind32(3fml)

名前

Ffind()、Ffind32() - バッファにあるフィールド・オカレンスの検索

形式

#include <stdio.h>  
#include "fml.h"  
char *  
Ffind(FBFR *fbfr, FLDID fieldid, FLDOCC oc, FLDLEN *len)  
#include "fml32.h"  
char *  
Ffind32(FBFR32 *fbfr, FLDID32 fieldid, FLDOCC32 oc, FLDLEN32 *len)

説明

Ffind()は、バッファ内の指定されたフィールド・オカレンスの値を検索します。fbfrは、フィールド化バッファを指すポインタです。fieldidは、フィールド識別子です。ocはフィールドのオカレンス番号です。フィールドがある場合、その長さは、*lenに設定され、その位置は、関数の値として返されます。lenの値がNULLの場合は、フィールドの長さは返されません。Ffind()は、フィールドの読取り専用アクセス権を取得する場合に使用できます。Ffind()によって返された値を使用してバッファを変更することはできません。

一般に、FLD_LONG、FLD_FLOAT、FLD_DOUBLE、FLD_PTR、FLD_FML32、およびFLD_VIEW32型の場合、それぞれの値がバッファ内で適切に配置されているとは限らないため、格納されているままの型を直接使用するのには向いていません。これらの値は、最初に、適宜に配列されたメモリー位置に複写される必要があります。変換関数CFfind()を使用してこのようなフィールドにアクセスする場合、検索される変換済の値は正しく配列されることが保証されます。バッファの変更は、関数Fadd()またはFchg()によってのみ行われる必要があります。Ffind()およびFfindlast()が戻す値は、バッファが変更されないかぎり有効です。

Ffind32()は、FLD_FML32およびFLD_VIEW32フィールド・タイプで提供される、埋め込み型のバッファ内の指定フィールドのオカレンスをチェックしません。

FLD_MBSTRING型の指定されたフィールド識別子の場合、Ffind32()の戻り値はFmbunpack(32)関数を使用して解析できます。

Ffind32()は32ビットFMLで使用されます。

マルチスレッドのアプリケーション内のスレッドは、TPINVALIDCONTEXTを含め、どのようなコンテキスト状態で実行していても、Ffind()またはFfind32()を呼び出すことができます。

戻り値

上記の「形式」の項では、Ffind()の戻り値のデータ型は、charのポインタ(Cのchar *)として記述されています。実際、戻されるポインタは、格納済のフィールドの型と同じ型を持つオブジェクトを指しています。

この関数は、エラー時にはNULLのポインタを返し、Ferrorを設定してエラー条件を示します。

エラー

次の条件の場合、Ffind()は異常終了し、Ferrorを次の値に設定します。

[FALIGNERR]

[FNOTFLD]

[FNOTPRES]

[FBADFLD]

関連項目

「FML関数の紹介」、Ffindlast、Ffindlast32(3fml)、Ffindocc、Ffindocc32(3fml)、Ffinds、Ffinds32(3fml)

Ffindlast、Ffindlast32(3fml)

名前

Ffindlast()、Ffindlast32() - バッファにあるフィールドの最後のオカレンスの値を検索

形式

#include <stdio.h>  
#include "fml.h"  
char *  
Ffindlast(FBFR *fbfr, FLDID fieldid, FLDOCC *oc, FLDLEN *len)  #include "fml32.h"  
char *  
Ffindlast32(FBFR32 *fbfr, FLDID32 fieldid, FLDOCC32 *oc, FLDLEN32 *len)

説明

Ffindlast()は、バッファ内でフィールドの最後のオカレンスを検索します。fbfrはフィールド化バッファを指すポインタです。fieldidはフィールド識別子です。ocはフィールドのオカレンス番号を受け取るために使用される整数型を指すポインタです。lenは値の長さです。バッファにフィールドのオカレンスがない場合は、NULLが返されます。通常、Ffindlast()の処理はFfind()に似ています。Ffindlastではユーザーがフィールド・オカレンスを指定しないのが大きな違いです。その代わり、フィールドの最後のオカレンスの値およびオカレンス番号の両方が返されます。最後のフィールドのオカレンス番号を返すために、Ffindlast()のオカレンス引数ocは、整数型のポインタであり、Ffind()の場合のように整数ではありません。ocがNULLで指定されている場合、最後のオカレンスのオカレンス番号は返されません。lenの値がNULLの場合は、フィールドの長さは返されません。

一般に、FLD_LONG、FLD_FLOAT、FLD_DOUBLE、FLD_PTR、FLD_FML32、およびFLD_VIEW32型の場合、それぞれの値がバッファ内で適切に配置されているとは限らないため、格納されているままの型を直接使用するのには向いていません。これらの値は、最初に、適宜に配列されたメモリー位置に複写される必要があります。変換関数CFfind()を使用してこのようなフィールドにアクセスする場合、検索される変換済の値は正しく配列されることが保証されます。バッファの変更は、関数Fadd()またはFchg()によってのみ行われる必要があります。Ffind()およびFfindlast()が戻す値は、バッファが変更されないかぎり有効です。

Ffindlast32()は、FLD_FML32およびFLD_VIEW32フィールド・タイプで提供される、埋め込み型のバッファ内の指定フィールドのオカレンスをチェックしません。

FLD_MBSTRING型の指定されたフィールド識別子の場合、Ffindlast32()の戻り値はFmbunpack(32)関数を使用して解析できます。

Ffindlast32()は32ビットFMLで使用されます。

マルチスレッドのアプリケーション内のスレッドは、TPINVALIDCONTEXTを含め、どのようなコンテキスト状態で実行していても、Ffindlast()またはFfindlast32()を呼び出すことができます。

戻り値

上記の「形式」の項では、Ffindlast()の戻り値のデータ型は、charのポインタ(Cのchar *)として記述されています。実際、戻されるポインタは、格納済のフィールドの型と同じ型を持つオブジェクトを指しています。

この関数は、エラー発生時にNULLを返し、Ferrorを設定してエラー条件を示します。

エラー

次の条件の場合、Ffindlast()は異常終了し、Ferrorを次の値に設定します。

[FALIGNERR]

[FNOTFLD]

[FNOTPRES]

[FBADFLD]

関連項目

「FML関数の紹介」、CFfind、CFfind32(3fml)、Fadd、Fadd32(3fml)、Fchg、Fchg32(3fml)、Ffind、Ffind32(3fml)、Ffindocc、Ffindocc32(3fml)、Ffinds、Ffinds32(3fml)

Ffindocc、Ffindocc32(3fml)

名前

Ffindocc()、Ffindocc32() - フィールド値のオカレンスの検索

形式

#include <stdio.h>  
#include "fml.h"  
FLDOCC  
Ffindocc(FBFR *fbfr, FLDID fieldid, char *value, FLDLEN len)  #include "fml32.h"  
FLDOCC32  
Ffindocc32(FBFR32 *fbfr, FLDID32 fieldid, char *value, FLDLEN32 len)

説明

Ffindocc()は、バッファ内の指定したフィールドのオカレンスを調べ、ユーザー指定のフィールド値と一致する最初のフィールド・オカレンスのオカレンス番号を返します。fbfrはフィールド化バッファを指すポインタです。fieldidはフィールド識別子です。検索される値は、valueパラメータが指す場所に含まれています。lenは値の長さです(FLD_CARRAY型またはFLD_MBSTRING型の場合)。fieldidのフィールド型がFLD_STRINGで、lenが0でない場合、パターン照合は文字列に対して実行されます。サポートされるパターン照合は、regcmp(3)で説明されるパターンと同じです(UNIXのリファレンス・マニュアルを参照)。さらに、正規表現のalternationがサポートされます(たとえば、''A|B''は''A''または''B''と一致します)。パターンはフィールド値全体と一致する必要があります(つまり、パターン''value''は暗黙に''^value$''として扱われます)。MS-DOSおよびOS/2環境で使用するために提供されるFfindocc()では、FLD_STRINGフィールドのregcmp()パターン照合はサポートされません。strcmp()が使用されます(UNIXのリファレンス・マニュアルを参照)。

上記の「形式」の項では、Ffindocc()の引数valueのデータ型は、charのポインタ(Cのchar *)として記述されています。技術的には、これは、Ffindocc()に渡すことのできる値のある特定の値のみを記述しています。実際、value引数の型は、検索されるフィールドのフィールド化バッファ表現の型と同じ型のオブジェクトのポインタである必要があります。たとえば、フィールドが、FLD_LONG型でバッファに格納されている場合は、valueの型は、long型のポインタ(Cのlong *)である必要があります。同様に、FLD_SHORT型でバッファに格納される場合、valueは、short型のポインタ(Cのshort *)である必要があります。大事な点は、Ffindocc()は、valueで指されるオブジェクトが、格納済の検索されるフィールドの型と同じ型を持っていることを想定していることです。

FLD_PTR型の値の場合、Ffindocc32()は指定されたポインタ値と一致するフィールドのオカレンスを検索します。FLD_FML32型の値の場合、すべてのフィールド・オカレンスおよび値が等しければ、2つのフィールドは等しいとみなされます。FLD_VIEW32型の値の場合、VIEW名が同じとき、およびすべての構造体メンバーのオカレンスおよび値が等しいとき、2つのフィールドは等しいとみなされます。

FLD_MBSTRING型の値の場合、値はFmbpack32()関数のパッキングされた出力引数であり、引数lenはFmbpack32()の出力引数sizeの値の長さです。

Ffindocc32()は32ビットFMLで使用されます。

マルチスレッドのアプリケーション内のスレッドは、TPINVALIDCONTEXTを含め、どのようなコンテキスト状態で実行していても、Ffindocc()またはFfindocc32()を呼び出すことができます。

戻り値

この関数は、エラー発生時に -1を返し、Ferrorを設定してエラー条件を示します。

エラー

次の条件の場合、Ffindocc()は異常終了し、Ferrorを次の値に設定します。

[FALIGNERR]

[FNOTFLD]

[FNOTPRES]

[FEINVAL]

[FBADFLD]

関連項目

「FML関数の紹介」、Ffind、Ffind32(3fml)、Ffindlast、Ffindlast32(3fml)、Ffinds、Ffinds32(3fml)、UNIXシステムのリファレンス・マニュアルのregcmp(3)

Ffinds、Ffinds32(3fml)

名前

Ffinds()、Ffinds32() - 文字列表現を指すポインタを返す

形式

#include <stdio.h>  
#include "fml.h"  
char *  
Ffinds(FBFR *fbfr, FLDID fieldid, FLDOCC oc)  
#include "fml32.h"  
char *  
Ffinds32(FBFR32 *fbfr, FLDID32 fieldid, FLDOCC32 oc)

説明

Ffinds()は、ユーザー型FLD_STRINGに変換する処理のために提供されます。fbfrは、フィールド化バッファを指すポインタです。fieldidは、フィールド識別子です。ocはフィールドのオカレンス番号です。指定されたフィールド・オカレンスは、検索されると、バッファにあるその型からNULL終了の文字列に変換されます。基本的に、このマクロは変換関数CFfind()を呼び出します。CFfind()は、utype (FLD_STRING)およびulen (値が0)を提供します。Ffinds()が返すポインタが妥当である期間は、CFfind()で記述されているものと同じです。

Ffinds32()は32ビットFMLで使用されます。

マルチスレッドのアプリケーション内のスレッドは、TPINVALIDCONTEXTを含め、どのようなコンテキスト状態で実行していても、Ffinds()またはFfinds32()を呼び出すことができます。

戻り値

この関数は、エラー発生時にNULLを返し、Ferrorを設定してエラー条件を示します。

エラー

次の条件の場合、Ffinds()は異常終了し、Ferrorを次の値に設定します。

[FALIGNERR]

[FNOTFLD]

[FNOTPRES]

[FBADFLD]

[FTYPERR]

[FMALLOC]

関連項目

「FML関数の紹介」、CFfind、CFfind32(3fml)、Ffind、Ffind32(3fml)

Ffloatev、Ffloatev32、Fvfloatev、Fvfloatev32(3fml)

名前

Ffloatev()、Ffloatev32()、Fvfloatev()、Fvfloatev32() - 式の値をdouble型で返す

形式

#include <stdio.h> 
#include "fml.h" 
double 
Ffloatev(FBFR *fbfr, char *tree) 
double 
Fvfloatev(char *cstruct, char *tree, char *viewname) 
#include "fml32.h" 
double 
Ffloatev32(FBFR32 *fbfr, char *tree) 
double 
Fvfloatev32(char *cstruct, char *tree, char *viewname)

説明

Ffloatev()は、フィールド化バッファのポインタ(fbfr)およびFboolco()が返す評価ツリーのポインタ(tree)を利用して、算術式の値(ツリーによって表される)をdouble型で返します。この関数は、フィールド化バッファあるいは評価ツリーのいずれも変更しません。

Ffloatev32()は32ビットFMLで使用されます。

Fvfloatev()およびFvfloatev32()は、同じVIEW機能を提供します。viewnameパラメータは、フィールド・オフセットを取り出すVIEWを示し、Fvboolco()またはFvboolco32()で指定されたVIEWと同じにする必要があります。

Workstationプラットフォームでは、これらの関数はサポートされていません。

マルチスレッドのアプリケーション内のスレッドは、TPINVALIDCONTEXTを含め、どのようなコンテキスト状態で実行していても、ここで記述する関数、Ffloatev()、Ffloatev32()、Fvfloatev()、またはFvfloatev32()を呼び出すことができます。

戻り値

正常終了時には、Ffloatev()は、表現の値をdoubleで返します。

この関数は、エラー発生時に -1を返し、Ferrorを設定してエラー条件を示します。

エラー

次の条件の場合、Ffloatev()は異常終了し、Ferrorを次の値に設定します。

[FALIGNERR]

[FNOTFLD]

[FMALLOC]

[FSYNTAX]

[FBADVIEW]

[FVFOPEN]

[EUNIX]

[FVFSYNTAX]

[FMALLOC]

関連項目

「FML関数の紹介」、Fboolco、Fboolco32、Fvboolco、Fvboolco32(3fml)、Fboolev、Fboolev32、Fvboolev、Fvboolev32(3fml)

Ffprint、Ffprint32(3fml)

名前

Ffprint()、Ffprint32() - フィールド化バッファを指定されたストリームに出力

形式

#include <stdio.h> 
#include "fml.h" 
int 
Ffprint(FBFR *fbfr, FILE *iop) 
#include "fml32.h" 
int 
Ffprint32(FBFR32 *fbfr, FILE *iop)

説明

Ffprint()は、テキストが指定された出力ストリームに出力されることを除いて、Fprint()に類似しています。fbfrは、フィールド化バッファを指すポインタです。iopは、出力ストリームを指すFILE型のポインタです。

バッファの各フィールドについて、フィールド名とフィールド値がタブで区切って出力されます。Fname()はフィールド名を決定するために使用されます。フィールド名が決定できない場合、フィールド識別子が出力されます。文字列または文字配列のフィールド値内の表示不能な文字は、バックスラッシュとその後に続く2文字の16進値で表現されます。バッファの出力が完了すると改行が出力されます。

FLD_PTR型の値の場合、Ffprint32()はフィールド名またはフィールド識別子、およびポインタ値を16進数で出力します。この関数はポインタ情報を出力しますが、Fextread32()関数はFLD_PTRフィールド・タイプを無視します。

FLD_FML32型の値の場合、Ffprint32()は各ネスト・レベルに先行タブを追加することにより、再帰的にFML32バッファを出力します。FLD_VIEW32型の値の場合、Ffprint32()はVIEW32フィールド名、および構造体メンバーの名前と値のペアを出力します。

Ffprint32()は32ビットFMLで使用されます。

マルチスレッドのアプリケーション内のスレッドは、TPINVALIDCONTEXTを含め、どのようなコンテキスト状態で実行していても、Ffprint()またはFfprint32()を呼び出すことができます。

戻り値

この関数は、エラー発生時に -1を返し、Ferrorを設定してエラー条件を示します。

エラー

次の条件の場合、Ffprint()は異常終了し、Ferrorを次の値に設定します。

[FALIGNERR]

[FNOTFLD]

[FMALLOC]

移植性

この関数は、Windows用のOracle Tuxedo System Workstation DLLでは使用できません。

関連項目

「FML関数の紹介」、Fprint、Fprint32(3fml)

Ffree、Ffree32(3fml)

名前

Ffree()、Ffree32() - フィールド化バッファ用に割り当てられた領域の解放

形式

#include <stdio.h> 
#include "fml.h" 
int 
Ffree(FBFR *fbfr) 
#include "fml32.h" 
int 
Ffree32(FBFR32 *fbfr)

説明

Ffree()は、その引数であるフィールド化バッファ用に割り当てられた領域を取り戻します。fbfrは、フィールド化バッファを指すポインタです。フィールド化バッファは無効化されます。つまり、フィールド化を解除して解放します。Ffree32()は、FLD_PTRフィールドのポインタによって参照されるメモリー領域を解放しません。

free()よりFfree()の使用をお薦めします(UNIXシステムのリファレンス・マニュアルを参照)。free()ではフィールド化バッファを無効にできませんが、Ffree()を使用するとフィールド化バッファを無効にできます。フィールド化バッファの無効化は重要です。malloc() (UNIXシステムのリファレンス・マニュアルを参照)は、解放されたメモリーをクリアせずに再利用するためです。free()を使用すると、malloc()が、有効なフィルード化バッファのように見えるがそうではないメモリーを返す可能性があります。

Ffree32()は32ビットFMLで使用されます。

マルチスレッドのアプリケーション内のスレッドは、TPINVALIDCONTEXTを含め、どのようなコンテキスト状態で実行していても、Ffree()またはFfree32()を呼び出すことができます。

戻り値

この関数は、エラー発生時に -1を返し、Ferrorを設定してエラー条件を示します。

エラー

次の条件の場合、Ffree()は異常終了し、Ferrorを次の値に設定します。

[FALIGNERR]

[FNOTFLD]

関連項目

「FML関数の紹介」、Falloc、Falloc32(3fml)、Frealloc、Frealloc32(3fml)

UNIXシステムのリファレンス・マニュアルのfree(3)、malloc(3)

Fget、Fget32(3fml)

名前

Fget()、Fget32() - フィールド・オカレンスのコピーおよび長さの取得

形式

#include <stdio.h> 
#include "fml.h" 
int 
Fget(FBFR *fbfr, FLDID fieldid, FLDOCC oc, char *loc, FLDLEN
  *maxlen) 
#include "fml32.h" 
int 
Fget32(FBFR32 *fbfr, FLDID32 fieldid, FLDOCC32 oc, char *loc,
  FLDLEN32 *maxlen)

説明

Fget()は、値が変更されたときに、フィールド化バッファのフィールドを検索するために使用されます。fbfrは、フィールド化バッファを指すポインタです。fieldidは、フィールド識別子です。ocはフィールドのオカレンス番号です。呼出し側は、プライベート・データ領域を指すポインタ(loc)、データ領域の長さ(*maxlen)をFget()に渡します。フィールドの長さは、*maxlenに返されます。関数が呼び出された時に、maxlenがNULLの場合は、そのフィールドの値(loc)のデータ領域がフィールド値を入れるのに十分大きいために、値が返されないと想定されます。locがNULLの場合は、値は検索されません。このように、この関数を呼び出すことにより、フィールドが存在するかどうかを確かめることができます。

上記の「形式」の項では、Fget()の引数valueのデータ型は、charのポインタ(Cのchar *)として記述されています。技術的には、これは、Fget()に渡すことのできる値のある特定の値のみを記述しています。実際、value引数の型は、検索されるフィールドのフィールド化バッファ表現の型と同じ型のオブジェクトのポインタである必要があります。たとえば、フィールドが、FLD_LONG型でバッファに格納されている場合は、valueの型は、long型のポインタ(Cのlong *)である必要があります。同様に、FLD_SHORT型でバッファに格納される場合、valueは、short型のポインタ(Cのshort *)である必要があります。大事なことは、Fget()はvalueで指されるオブジェクトが、検索される格納済のフィールドの型と同じ型を持っていることを想定していることです。

FLD_MBSTRING型の指定されたフィールド識別子の場合、Fget32()の戻り値はFmbunpack(32)関数を使用して解析できます。

Fget32()は32ビットFMLで使用されます。

マルチスレッドのアプリケーション内のスレッドは、TPINVALIDCONTEXTを含め、どのコンテキスト状態で実行している場合でも、Fget()またはFget32()を呼び出すことができます。

戻り値

Fget32()がFLD_VIEW32フィールド・タイプで使用されると、FVIEWFLD構造体を指すポインタが戻されます。この関数は、エラー発生時に-1を戻し、Ferrorを設定してエラー条件を示します。

エラー

次の条件の場合、Fget()は異常終了し、Ferrorを次の値に設定します。

[FALIGNERR]

[FNOTFLD]

[FNOSPACE]

[FNOTPRES]

[FBADFLD]

関連項目

「FML関数の紹介」、CFget、CFget32(3fml)、Fgetalloc、Fgetalloc32(3fml)、Fgetlast、Fgetlast32(3fml)、Fgets、Fgets32(3fml)、Fgetsa、Fgetsa32(3fml)

Fgetalloc、Fgetalloc32(3fml)

名前

Fgetalloc()、Fgetalloc32() - 領域の割り当て、およびフィールド・オカレンスのコピーの取得

形式

#include <stdio.h> 
#include "fml.h" 
char * 
Fgetalloc(FBFR *fbfr, FLDID fieldid, FLDOCC oc, FLDLEN *extralen)
#include "fml32.h" 
char * 
Fgetalloc32(FBFR32 *fbfr, FLDID32 fieldid, FLDOCC32 oc, FLDLEN32
  *extralen)

説明

Fget()同様、Fgetalloc()は、バッファ・フィールドのコピーの検索および作成を行いますが、malloc() (UNIXシステムのプログラマ・リファレンス・マニュアル)を介してフィールド用の領域を取得します。fbfrは、フィールド化バッファを指すポインタです。fieldidは、フィールド識別子です。ocはフィールドのオカレンス番号です。Fgetalloc()の最後の引数extralenは、フィールド値の大きさに加えて取得される予備の領域の大きさを提供します。それは、取得される値が、フィールド化バッファに再挿入される前に拡張される場合に使用されます。extralenがNULLの場合、割り当てる追加領域はなく、実際の長さは返されません。Fgetalloc()で取得した領域をfree()で解放する処理は、呼出し側プログラムの役割です。バッファは、あらゆるフィールドの型に対して正しく並べられます。

FLD_MBSTRING型の指定されたフィールド識別子の場合、Fgetalloc32()の戻り値はFmbunpack(32)関数を使用して解析できます。

Fgetalloc32()は32ビットFMLで使用されます。

マルチスレッドのアプリケーション内のスレッドは、TPINVALIDCONTEXTを含め、どのコンテキスト状態で実行している場合でも、Fgetalloc()またはFgetalloc32()を呼び出すことができます。

戻り値

上記の「形式」の項では、Fgetalloc()の戻り値のデータ型は、charのポインタ(Cのchar *)として記述されています。実際、戻されるポインタは、格納済のフィールドの型と同じ型を持つオブジェクトを指しています。Fgetalloc32()がFLD_VIEW32フィールド・タイプで使用されると、FVIEWFLD構造体を指すポインタが戻されます。この関数は、エラー発生時にNULLを戻し、Ferrorを設定してエラー条件を示します。

エラー

次の条件の場合、Fgetalloc()は異常終了し、Ferrorを次の値に設定します。

[FALIGNERR]

[FNOTFLD]

[FNOTPRES]

[FBADFLD]

[FMALLOC]

関連項目

「FML関数の紹介」、CFget、CFget32(3fml)、Fget、Fget32(3fml)、Fgetlast、Fgetlast32(3fml)、Fgets、Fgets32(3fml)、Fgetsa、Fgetsa32(3fml)

UNIXシステムのリファレンス・マニュアルのfree(3)、malloc(3)

Fgetlast、Fgetlast32(3fml)

名前

Fgetlast()、Fgetlast32() - 最後のオカレンスのコピーの取得

形式

#include <stdio.h> 
#include "fml.h" 
int 
Fgetlast(FBFR *fbfr, FLDID fieldid, FLDOCC *oc, char *value, FLDLEN
  *maxlen) 
#include "fml32.h" 
int 
Fgetlast32(FBFR32 *fbfr, FLDID32 fieldid, FLDOCC32 *oc, char
  *value, FLDLEN32 *maxlen)

説明

Fgetlast()は、フィールド識別子(fieldid)で識別される最後のオカレンスの値とオカレンス番号の両方を検索するために使用されます。fbfrは、フィールド化バッファを指すポインタです。最後のフィールドのオカレンス番号を返すため、オカレンスの引数(oc)は、整数型を指すポインタであり、整数ではありません。

呼出し側は、プライベート・バッファを指すポインタ(loc)、バッファの長さ(*maxlen)をFgetlast()に提供します。フィールドの長さは、*maxlenに返されます。関数が呼び出された時に、maxlenがNULLの場合は、そのフィールド値のバッファがフィールド値を入れるのには十分に大きいために、値が返されないと想定されます。locがNULLの場合、値は返されません。ocがNULLの場合は、オカレンスは、返されません。

上記の「形式」の項では、Fget()の引数valueのデータ型は、charのポインタ(Cのchar *)として記述されています。技術的には、これは、Fget()に渡すことのできる値のある特定の値のみを記述しています。実際、value引数の型は、検索されるフィールドのフィールド化バッファ表現の型と同じ型のオブジェクトのポインタである必要があります。たとえば、フィールドが、FLD_LONG型でバッファに格納されている場合は、valueの型は、long型のポインタ(Cのlong *)である必要があります。同様に、FLD_SHORT型でバッファに格納される場合、valueは、short型のポインタ(Cのshort *)である必要があります。大事なことは、Fget()はvalueで指されるオブジェクトが、検索される格納済のフィールドの型と同じ型を持っていることを想定していることです。

FLD_MBSTRING型の指定されたフィールド識別子の場合、Fgetlast32()の戻り値はFmbunpack(32)関数を使用して解析できます。

Fgetlast32()は32ビットFMLで使用されます。

マルチスレッドのアプリケーション内のスレッドは、TPINVALIDCONTEXTを含め、どのコンテキスト状態で実行している場合でも、Fgetlast()またはFgetlast32()を呼び出すことができます。

戻り値

この関数は、エラー発生時に -1を返し、Ferrorを設定してエラー条件を示します。

エラー

次の条件の場合、Fgetlast()は異常終了し、Ferrorを次の値に設定します。

[FALIGNERR]

[FNOTFLD]

[FNOSPACE]

[FNOTPRES]

[FBADFLD]

関連項目

「FML関数の紹介」、Fget、Fget32(3fml)、Fgetalloc、Fgetalloc32(3fml)、Fgets、Fgets32(3fml)、Fgetsa、Fgetsa32(3fml)

Fgets、Fgets32(3fml)

名前

Fgets()、Fgets32() - 値を文字列に変換

形式

#include <stdio.h> 
#include "fml.h" 
int 
Fgets(FBFR *fbfr, FLDID fieldid, FLDOCC oc, char *buf) 
#include "fml32.h" 
int 
Fgets32(FBFR32 *fbfr, FLDID32 fieldid, FLDOCC32 oc, char *buf)

説明

Fgets()は、フィールド化バッファからフィールド・オカレンスを検索し、値をユーザー型FLD_STRINGに変換します。fbfrは、フィールド化バッファを指すポインタです。fieldidは、フィールド識別子です。ocはフィールドのオカレンス番号です。Fgets()の呼出し側は、プライベート・バッファを指すポインタ(buf)を提供します。プライベート・バッファは、検索されるフィールド値のために使用されます。bufは、値を保持するために十分に大きいと想定されています。基本的に、Fgets()は、想定されているutype (FLD_STRING)およびulen (値が0)を利用してCFget()を呼び出します。

Fgets32()は32ビットFMLで使用されます。

マルチスレッドのアプリケーション内のスレッドは、TPINVALIDCONTEXTを含め、どのコンテキスト状態で実行している場合でも、Fgets()またはFgets32()を呼び出すことができます。

戻り値

この関数は、エラー発生時に -1を返し、Ferrorを設定してエラー条件を示します。

エラー

次の条件の場合、Fgets()は異常終了し、Ferrorを次の値に設定します。

[FALIGNERR]

[FNOTFLD]

[FNOTPRES]

[FBADFLD]

[FTYPERR]

[FMALLOC]

関連項目

「FML関数の紹介」、CFget、CFget32(3fml)、Fget、Fget32(3fml)、Fgetalloc、Fgetalloc32(3fml)、Fgetlast、Fgetlast32(3fml)、Fgetsa、Fgetsa32(3fml)

Fgetsa、Fgetsa32(3fml)

名前

Fgetsa()、Fgetsa32() - malloc()で領域を割り当て、変換された値を取得する

形式

#include <stdio.h> 
#include "fml.h" 
char * 
Fgetsa(FBFR *fbfr, FLDID fieldid, FLDOCC oc, FLDLEN *extra)
#include "fml32.h" 
char * 
Fgetsa32(FBFR32 *fbfr, FLDID32 fieldid, FLDOCC32 oc, FLDLEN32
  *extra)

説明

Fgetsa()はCFgetalloc()を呼び出すマクロです。fbfrは、フィールド化バッファを指すポインタです。fieldidは、フィールド識別子です。ocはフィールドのオカレンス番号です。この関数はmalloc() (UNIXシステムのプログラマ・リファレンス・マニュアル)を使用して、文字列に変換して取得したフィールド値のための領域を割り当てます。extraがNULLでない場合、extraには、フィールド値の大きさに加えて割り当てる余分な領域を指定します。全体の大きさは、extraに返ります。

malloc()で割り当てた領域を(UNIXシステムのリファレンス・マニュアルの) free()を使用して解放するのは、ユーザーの責任です。

Fgetsa32()は32ビットFMLで使用されます。

マルチスレッドのアプリケーション内のスレッドは、TPINVALIDCONTEXTを含め、どのコンテキスト状態で実行している場合でも、Fgetsa()またはFgetsa32()を呼び出すことができます。

戻り値

正常終了の場合、割り当てられたバッファを指すポインタを返します。

この関数は、エラー発生時にNULLを返し、Ferrorを設定してエラー条件を示します。

エラー

次の条件の場合、Fgetsa()は異常終了し、Ferrorを次の値に設定します。

[FALIGNERR]

[FNOTFLD]

[FNOTPRES]

[FBADFLD]

[FTYPERR]

[FMALLOC]

関連項目

「FML関数の紹介」、CFget、CFget32(3fml)、Fget、Fget32(3fml)、Fgetlast、Fgetlast32(3fml)、Fgets、Fgets32(3fml)

UNIXシステムのリファレンス・マニュアルのfree(3)、malloc(3)

Fidnm_unload、Fidnm_unload32(3fml)

名前

Fidnm_unload()、Fidnm_unload32() - id->nmマッピング表から領域を取り戻す

形式

#include <stdio.h> 
#include "fml.h" 
void 
Fidnm_unload(void); 
#include "fml32.h" 
void 
Fidnm_unload32(void);

説明

Fidnm_unload()は、Fname()によってフィールド識別子用に割り当てられた領域を、フィールド名のマッピング表用に取り戻します。

Fidnm_unload32()は32ビットFMLで使用されます。

マルチスレッドのアプリケーション内のスレッドは、TPINVALIDCONTEXTを含め、どのようなコンテキスト状態で実行していても、Fidnm_unload()またはFidnm_unload32()を呼び出すことができます。

戻り値

この関数は、void宣言のため何も返しません。

関連項目

「FML関数の紹介」、Fname、Fname32(3fml)、Fnmid_unload、Fnmid_unload32(3fml)

Fidxused、Fidxused32(3fml)

名前

Fidxused()、Fidxused32() - 使用されている領域の大きさを返す

形式

#include <stdio.h> 
#include "fml.h" 
long 
Fidxused(FBFR *fbfr) 
#include "fml32.h" 
long 
Fidxused32(FBFR32 *fbfr)

説明

Fidxused()は、バッファの索引で使用している現在の領域の大きさを示します。fbfrは、フィールド化バッファを指すポインタです。

Fidxused32()は32ビットFMLで使用されます。

マルチスレッドのアプリケーション内のスレッドは、TPINVALIDCONTEXTを含め、どのコンテキスト状態で実行している場合でも、Fidxused()またはFidxused32()を呼び出すことができます。

戻り値

正常終了の場合、索引で使用しているバッファ内の領域の大きさを戻します。この関数は、エラー発生時に-1を戻し、Ferrorを設定してエラー条件を示します。

エラー

次の条件の場合、Fidxused()は、異常終了してFerrorを次のように設定します。

[FALIGNERR]

[FNOTFLD]

関連項目

「FML関数の紹介」、Findex、Findex32(3fml)、Frstrindex、Frstrindex32(3fml)、Funused、Funused32(3fml)、Fused、Fused32(3fml)

Fielded、Fielded32(3fml)

名前

Fielded()、Fielded32() - バッファがフィールド化されている場合は、trueを返す

形式

#include stdio.h> 
#include "fml.h" 
int 
Fielded(FBFR *fbfr) 
#include "fml32.h" 
int 
Fielded32(FBFR32 *fbfr)

説明

Fielded()は、指定されたバッファがフィールド化されているかを調べるのに使用されます。fbfrは、フィールド化バッファを指すポインタです。

Fielded32()は32ビットFMLで使用されます。

マルチスレッドのアプリケーション内のスレッドは、TPINVALIDCONTEXTを含め、どのコンテキスト状態で実行している場合でも、Fielded()またはFielded32()を呼び出すことができます。

戻り値

Fielded()は、バッファがフィールド化されている場合にはtrueを戻します。また、バッファがフィールド化されていない場合は、falseを戻しますが、この場合はFerrorを設定しません。

関連項目

「FML関数の紹介」、Finit、Finit32(3fml)、Fneeded、Fneeded32(3fml)、Fsizeof、Fsizeof32(3fml)

Findex、Findex32(3fml)

名前

Findex()、Findex32() - フィールド化バッファの索引を行う

形式

#include <stdio.h> 
#include "fml.h" 
int 
Findex(FBFR *fbfr, FLDOCC intvl) 
#include "fml32.h" 
int 
Findex32(FBFR32 *fbfr, FLDOCC32 intvl)

説明

Findex()は、フィールド化バッファのインデックスを行うために明示的に呼び出されます。fbfrは、フィールド化バッファを指すポインタです。2番目のパラメータintvlには、インデックスの間隔を指定します。つまり、インデックスするフィールドを理想的に分離します。この引数の値が0の場合、バッファの現在のインデックス値が使用されます。現在の値そのものが0の場合、値FSTDXINTVL (デフォルトは16)が使用されます。インデックス値に1を使用すると、必ず、バッファにあるすべてのフィールドがインデックスされます。インデックス間隔の大きさとバッファのインデックスに割り当てられる領域の大きさは、反比例します。したがって、間隔が小さいとより多くのフィールドがインデックスされ、より多くの領域が使用されます。

Findex32()は32ビットFMLで使用されます。

マルチスレッドのアプリケーション内のスレッドは、TPINVALIDCONTEXTを含め、どのコンテキスト状態で実行している場合でも、Findex()またはFindex32()を呼び出すことができます。

戻り値

この関数は、エラー発生時に -1を返し、Ferrorを設定してエラー条件を示します。

エラー

次の条件の場合、Findex()は異常終了し、Ferrorを次の値に設定します。

[FALIGNERR]

[FNOTFLD]

[FNOSPACE]

関連項目

「FML関数の紹介」、Fidxused、Fidxused32(3fml)、Frstrindex、Frstrindex32(3fml)、Funindex、Funindex32(3fml)

Finit、Finit32(3fml)

名前

Finit()、Finit32() - フィールド化バッファを初期化

形式

#include <stdio.h> 
#include "fml.h" 
int 
Finit(FBFR *fbfr, FLDLEN buflen) 
#include "fml32.h" 
int 
Finit32(FBFR32 *fbfr, FLDLEN32 buflen)

説明

Finit()は、フィールド化バッファを静的に初期化するために呼び出されます。fbfrは、フィールド化バッファを指すポインタです。buflenは、バッファの長さです。この関数はバッファ・ポインタとバッファの長さを取り、フィールドのないバッファのために内部構造体を設定します。前に使用されたバッファを再初期化するにはFinit()も使用できます。

Finit32()は32ビットFMLで使用されます。

マルチスレッドのアプリケーション内のスレッドは、TPINVALIDCONTEXTを含め、どのようなコンテキスト状態で実行していても、Finit()またはFinit32()を呼び出すことができます。

戻り値

この関数は、エラー発生時に -1を返し、Ferrorを設定してエラー条件を示します。

エラー

次の条件の場合、Finit()は異常終了し、Ferrorを次の値に設定します。

[FALIGNERR]

[FNOTFLD]

[FNOSPACE]

例

フィールドを持たないようバッファを再初期化する正しい方法は、Finit(fbfr, (FLDLEN)Fsizeof(fbfr));です。

関連項目

「FML関数の紹介」、Falloc、Falloc32(3fml)、Fneeded、Fneeded32(3fml)、Frealloc、Frealloc32(3fml)

Fjoin、Fjoin32(3fml)

名前

Fjoin()、Fjoin32() - ソース・バッファを宛先バッファに組み込む

形式

#include stdio.h> 
#include "fml.h" 
int 
Fjoin(FBFR *dest, FBFR *src) 
#include "fml32.h" 
int 
Fjoin32(FBFR32 *dest, FBFR32 *src)

説明

Fjoin()は、2つのバッファをフィールド識別子/オカレンスの整合に基づいて結合するために使用されます。destは、宛先バッファを指すポインタです。srcは、元のフィールド化バッファを指すポインタです。フィールドID/オカレンスと一致するフィールドの場合は、フィールド値はソース・バッファの値を使って宛先バッファで更新されます。ソース・バッファ内に、対応するfieldidとオカレンスの組合せがない場合、宛先バッファのフィールドは削除されます。バッファを組み込むことによりFLD_PTRフィールドが削除されても、ポインタによって参照されるメモリー領域は変更または解放されません。

新しい値が古い値より大きい場合は、この関数は領域の不足のために失敗することがあります。その場合、宛先バッファは変更されます。ただし、その場合は、Frealloc()を使用し、Fjoin()関数を繰返し呼び出して、宛先バッファを再割り当てできます。宛先バッファが部分的に更新された場合でさえ、Fjoin()関数を繰り返すことで正しい結果が取得されます。

Fjoin32()は32ビットFMLで使用されます。

マルチスレッドのアプリケーション内のスレッドは、TPINVALIDCONTEXTを含め、どのようなコンテキスト状態で実行していても、Fjoin()またはFjoin32()を呼び出すことができます。

戻り値

この関数は、エラー発生時に -1を返し、Ferrorを設定してエラー条件を示します。

エラー

次の条件の場合、Fjoin()は異常終了し、Ferrorを次の値に設定します。

[FALIGNERR]

[FNOTFLD]

[FNOSPACE]

例

次に使用例を示します。

FBFR *src, *dest;  ...  if(Fjoin(dest,src)  0)  F_error("pgm_name");

destがフィールドA、BおよびCオカレンスを2個持っており、srcが、フィールドA、CおよびDを持っている場合、結果的に、destは、元のフィールド値Aおよび元のフィールド値Cを持つことになります。

関連項目

「FML関数の紹介」、Fconcat、Fconcat32(3fml)、Fojoin、Fojoin32(3fml)、Fproj、Fproj32(3fml)、Fprojcpy、Fprojcpy32(3fml)、Frealloc、Frealloc32(3fml)

Fldid、Fldid32(3fml)

名前

Fldid()、Fldid32() - フィールド名をフィールド識別子にマップする

形式

#include <stdio.h> 
#include "fml.h" 
 
FLDID 
Fldid(char *name) 
 
#include "fml32.h" 
 
FLDID32 
Fldid32(char *name)

説明

Fldid()は、フィールド名からフィールド識別子を導くランタイムな変換機能を提供し、そのフィールドのnameパラメータに対応したFLDIDを戻します。最初の呼出しでは、フィールド表用の領域が動的に割り当てられ、表がロードされます。Fldid()でロードしたフィールド表が占有しているデータ領域を回復するには、Fnmid_unload()関数を呼び出してファイルをアンロードする必要があります。

Fldid32()は32ビットFMLで使用されます。

マルチスレッドのアプリケーション内のスレッドは、TPINVALIDCONTEXTを含め、どのコンテキスト状態で実行している場合でも、Fldid()またはFldid32()を呼び出すことができます。

戻り値

この関数は、エラー時にはBADFLDIDを返し、Ferrorを設定してエラー条件を示します。

エラー

次の条件の場合、Fldid()は異常終了し、Ferrorを次の値に設定します。

[FBADNAME]

[FMALLOC]

関連項目

「FML関数の紹介」、Fldno、Fldno32(3fml)、Fname、Fname32(3fml)、Fnmid_unload、Fnmid_unload32(3fml)

UNIXシステムのリファレンス・マニュアルのmalloc(3)

Fldno、Fldno32(3fml)

名前

Fldno()、Fldno32() - フィールド識別子をフィールド番号にマップする

#include <stdio.h> 
#include "fml.h" 
 
int 
Fldno(FLDID fieldid) 
 
#include "fml32.h" 
 
long 
Fldno32(FLDID32 fieldid)

説明

Fldno()は、パラメータとしてフィールド識別子(fieldid)を受け取り、識別子にあるフィールド番号を返します。

Fldno32()は32ビットFMLで使用されます。

マルチスレッドのアプリケーション内のスレッドは、TPINVALIDCONTEXTを含め、どのコンテキスト状態で実行している場合でも、Fldno()またはFldno32()を呼び出すことができます。

戻り値

この関数は、フィールド番号を返します。エラーは返しません。

関連項目

「FML関数の紹介」、Fldid、Fldid32(3fml)、Fldtype、Fldtype32(3fml)

Fldtype、Fldtype32(3fml)

名前

Fldtype()、Fldtype32() - フィールド識別子をフィールド・タイプにマップする

形式

#include <stdio.h> 
#include "fml.h" 
 
int 
Fldtype(FLDID fieldid) 
 
#include "fml32.h" 
 
int 
Fldtype32(FLDID32 fieldid)

説明

Fldtype()は、フィールド識別子(fieldid)を受け取り、fml.hで定義されているように、識別子(整数)にあるフィールド・タイプを返します。

Fldtype32()は32ビットFMLで使用されます。

マルチスレッドのアプリケーション内のスレッドは、TPINVALIDCONTEXTを含め、どのコンテキスト状態で実行している場合でも、Fldtype()またはFldtype32()を呼び出すことができます。

戻り値

この関数は、フィールド・タイプを返します。

関連項目

「FML関数の紹介」、Fldid、Fldid32(3fml)、Fldno、Fldno32(3fml)

Flen、Flen32(3fml)

名前

Flen()、Flen32() - バッファ中のフィールド・オカレンスのlenを返します。

形式

#include <stdio.h> 
#include "fml.h" 
 
int 
Flen(FBFR *fbfr, FLDID fieldid, FLDOCC oc) 
 
#include "fml32.h" 
 
long 
Flen32(FBFR32 *fbfr, FLDID32 fieldid, FLDOCC32 oc) 

説明

Flen()は、バッファ中の指定したフィールド・オカレンスの値を見つけ出し、そのフィールド長を返します。fbfrは、フィールド化バッファを指すポインタです。fieldidは、フィールド識別子です。ocはフィールドのオカレンス番号です。

FLD_PTR型の値の場合、Flen32()はsizeof(char*)に基づくポインタ・フィールドの固定長を戻します。FLD_FML32型の値の場合、Flen32()はネストされたバッファの長さに対するFused32()の値を戻します。FLD_VIEW32型の値の場合、Flen32()はVIEWデータの長さとVIEW名の長さを戻します。

FLD_MBSTRING型の値の場合、Flen32()はFmbpack32()で作成され、パッキングされた出力の長さを返します。

Flen32()は32ビットFMLで使用されます。

マルチスレッドのアプリケーション内のスレッドは、TPINVALIDCONTEXTを含め、どのコンテキスト状態で実行している場合でも、Flen()またはFlen32()を呼び出すことができます。

戻り値

Flen()は、正しく終了するとフィールド長を返します。

この関数は、エラー発生時に -1を返し、Ferrorを設定してエラー条件を示します。

エラー

次の条件が発生すると、Flen()は異常終了し、Ferrorを次のように設定します。

[FALIGNERR]

[FNOTFLD]

[FNOTPRES]

[FBADFLD]

関連項目

「FML関数の紹介」、Fnum、Fnum32(3fml)、Fpres、Fpres32(3fml)

Fmbpack32(3fml)

名前

Fmbpack32() - エンコーディング名およびマルチバイト・データ情報を準備する

形式

#include "fml32.h"

int
Fmbpack32 (char *enc,void *ind,FLDLEN32 indlen,void 
*packed,FLDLEN32 *size,long flags)

説明

Fmbpack32()は、FML32型付きバッファに入力されたFLD_MBSTRINGフィールドのエンコーディング名およびマルチバイト・データ情報を準備します。Fmbpack32()は、FLD_MBSTRINGフィールドがFML32 APIでFML32バッファに追加される前に使用します。

encは、NULLでない場合、コード・セットのマルチバイト・データ(ind)に対するコード・セットのエンコーディング名を保持するASCII文字列(NULLで終了)です。encがNULL、引数flagsが0の場合、出力packedに含められるエンコーディング名は、プロセスTPMBENC環境変数から取得されます。引数flagsがFBUFENCの場合、encは無視されます。

indは、コード・セットのマルチバイト・データです。

indlenは、indのバイト数です。

packedは、Fmbpack32()の出力を指すポインタです。これは、FML32バッファにFLD_MBSTRINGフィールドを含めるFML32 APIの入力値として使用されます。パック領域は、FLDLEN32(TM32U)バウンダリに配置する必要があります。

入力でのsizeは、packedが指すメモリー・サイズです。サイズがFmbpack32()の結果の処理には不十分な場合、FNOSPACEが戻され、sizeはpackedのバイト数にリセットされます。Fmbpack32()が正常に実行された後、sizeは実際に使用されたバイト数にリセットされます。

flagsは、0またはFBUFENCです。flagsをFBUFENCに設定すると、Fmbpack32()は引数encを無視し、FBUFENCをpackedの入力データと共に含めます。エンコーディング名を指定しない場合、出力packedは、FML32 APIによって強制的にFLD_MBSTRINGフィールドでエンコーディング名をFML32バッファから取得するよう処理します。したがって、FBUFENCを使用する場合、FML32バッファのエンコーディング名を設定するために、アプリケーション開発者はtpsetmbenc()も使用する必要があります。

戻り値

Fmbpack32()は、正しく終了すると正の値を戻します。Fmbpack32()は、エラー発生時に-1を戻し、Ferror32を設定してエラー条件を示します。

エラー

次の条件の場合、Fmbpack32()は異常終了し、Ferror32を次の値に設定します。

[FEINVAL]

[FNOSPACE]

関連項目

Fmbunpack32(3fml)、tpconvfmb32(3fml)、tpsetmbenc(3c)、tuxgetmbenc(3c)、tuxsetmbenc(3c)

Fmbunpack32(3fml)

名前

Fmbunpack32() - エンコーディング名およびマルチバイト・データ情報を抽出する

形式

#include "fml32.h"

int
Fmbunpack32 (void *packed,FLDLEN32 ilen,char *enc,void 
*outd,FLDLEN32 *olen,long flags)

説明

Fmbunpack32()は、FML32型付きバッファ内のFLD_MBSTRINGフィールドからエンコーディング名およびマルチバイト・データ情報を抽出します。Fmbunpack32()は、FLD_MBSTRINGフィールドがFML32 API (Ffind32()、Fget32()、など)でFML32バッファから抽出された後に使用します。

packedは、FML32 APIで出力されたFLD_MBSTRINGフィールドのデータを指すポインタです。

ilenは、packedのバイト数です。

encは、FLD_MBSTRINGフィールドのコード・セットのエンコーディング名が、パッキングされた情報(packed)の一部である場合に、エンコーディング名を保持するpacked内のASCII文字列(NULLで終了)です。FBUFENCフラグを設定してFmbpack32()でFLD_MBSTRINGフィールドを作成した場合、encはNULLに設定します。後者の場合、アプリケーション開発者は、FML32バッファでtpgetmbenc()を使用して、FLD_MBSTRINGフィールドのエンコーディング名を取得する必要があります。

outdには、Fmbunpack32()の正常終了時にpackedから抽出されるマルチバイト・データが入ります。

入力でのolenは、outdが指すメモリー・サイズです。サイズがFmbunpack32()の結果の処理には不十分な場合、FNOSPACEが戻され、olenはoutdのバイト数にリセットされます。Fmbunpack32()が正常に実行された後、olenは実際に使用されたバイト数にリセットされます。

flagsは現在使用されていないので、0に設定します。

戻り値

Fmbunpack32()は、正しく終了すると正の値を戻します。Fmbunpack32()は、エラー発生時に-1を戻し、Ferror32を設定してエラー条件を示します。

エラー

次の条件の場合、Fmbunpack32()は異常終了し、Ferror32を次の値に設定します。

[FEINVAL]

[FNOSPACE]

関連項目

Fmbpack32(3fml)、tpconvfmb32(3fml)、tpgetmbenc(3c)、tuxgetmbenc(3c)、tuxsetmbenc(3c)

Fmkfldid、Fmkfldid32(3fml)

名前

Fmkfldid()、Fmkfldid32() - フィールド識別子を作成

#include <stdio.h> 
#include "fml.h" 
 
FLDID 
Fmkfldid(int type, FLDID num) 
 
#include "fml.h" 
 
FLDID32 
Fmkfldid32(int type, FLDID32 num)

説明

Fmkfldid()によって、有効な型(fml.hで定義されている)から有効なフィールド識別子を作成できます。フィールド番号を順次選択するアプリケーション・ジェネレータをコーディングする場合、あるいはフィールド識別子を再作成する場合に役立ちます。

typeは、有効なフィールド・タイプです(整数。「Fldtype、Fldtype32(3fml)」を参照)。numは、フィールド番号です(現在あるフィールドとの混同をさけるために未使用のフィールド番号でなければなりません)。

Fmkfldid32()は32ビットFMLで使用されます。

マルチスレッドのアプリケーション内のスレッドは、TPINVALIDCONTEXTを含め、どのようなコンテキスト状態で実行していても、Fmkfldid()またはFmkfldid32()を呼び出すことができます。

戻り値

この関数は、エラー時にはBADFLDIDを返し、Ferrorを設定してエラー条件を示します。

エラー

次の条件の場合、Fmkfldid()は異常終了し、Ferrorを次の値に設定します。

[FBADFLD]

[FTYPERR]

関連項目

「FML関数の紹介」、Fldtype、Fldtype32(3fml)

Fmove、Fmove32(3fml)

名前

Fmove()、Fmove32() - フィールド化バッファを宛先バッファに移動

形式

#include <stdio.h> 
#include "fml.h" 
 
int 
Fmove(char *dest, FBFR *src) 
 
#include "fml32.h" 
 
int 
Fmove32(char *dest, FBFR32 *src)

説明

Fmove()は、フィールド化バッファから任意の型のバッファに複写するときに使用されます。destは、宛先バッファを指すポインタです。srcは、元のフィールド化バッファを指すポインタです。

Fmove()とFcpy()の違いは、Fcpy()は宛先がフィールド化バッファであることを想定し、ソース・バッファのデータを収容できる十分なサイズがあることを確認できることです。Fmove()ではそのようなチェックは行われません。Fsizeof()のバイト数のデータを、ソースのフィールド化バッファからターゲットのバッファに移動するだけです。宛先バッファは、shortバウンダリで並んでいる必要があります。

FLD_PTR型の値の場合、Fmove32()はバッファ・ポインタを渡します。アプリケーション・プログラマは、対応するポインタの移動に応じてバッファの再割り当て、および解放を管理する必要があります。

Fmove32()は32ビットFMLで使用されます。

マルチスレッドのアプリケーション内のスレッドは、TPINVALIDCONTEXTを含め、どのコンテキスト状態で実行している場合でも、Fmove()またはFmove32()を呼び出すことができます。

戻り値

この関数は、エラー発生時に -1を返し、Ferrorを設定してエラー条件を示します。

エラー

次の条件の場合、Fmove()は異常終了し、Ferrorを次の値に設定します。

[FALIGNERR]

[FNOTFLD]

関連項目

「FML関数の紹介」、Fcpy、Fcpy32(3fml)、Fsizeof、Fsizeof32(3fml)

Fname、Fname32(3fml)

名前

Fname()、Fname32() - フィールド識別子をフィールド名にマップする

形式

#include <stdio.h> 
#include "fml.h" 
 
char * 
Fname(FLDID fieldid) 
 
#include "fml32.h" 
 
char * 
Fname32(FLDID32 fieldid)

説明

Fname()は、フィールド識別子(fieldid)からフィールド名を導くランタイムな変換機能を提供し、引数に対応した名前を持つ文字列を指すポインタを戻します。最初の呼出しでは、フィールド表用の領域が動的に割り当てられ、表がロードされます。Fname()で作成したマッピング表によって使用されている表領域は、Fidnm_unload()関数を呼び出して回復することができます。

Fname32()は32ビットFMLで使用されます。

マルチスレッドのアプリケーション内のスレッドは、TPINVALIDCONTEXTを含め、どのコンテキスト状態で実行している場合でも、Fname()またはFname32()を呼び出すことができます。

戻されたポインタは内部FML表で保持されます。マルチスレッド・アプリケーションが、戻されたポインタへの参照を解除する場合は、アプリケーション・コード自体でスレッド・セーフにする必要があります。Fnmid_unload/Fidnm_unloadが発行された場合は、Fnameによって戻されたポインタへの参照を解除しないでください。

戻り値

この関数は、エラー発生時にNULLを返し、Ferrorを設定してエラー条件を示します。

エラー

次の条件の場合、Fname()は異常終了し、Ferrorを次の値に設定します。

[FBADFLD]

[FMALLOC]

関連項目

「FML関数の紹介」、Ffprint、Ffprint32(3fml)、Fidnm_unload、Fidnm_unload32(3fml)、Fldid、Fldid32(3fml)、Fprint、Fprint32(3fml)

Fneeded、Fneeded32(3fml)

名前

Fneeded()、Fneeded32() - バッファに必要な大きさの計算

形式

#include <stdio.h> 
#include "fml.h" 
 
long 
Fneeded(FLDOCC F, FLDLEN V) 
 
#include "fml32.h" 
 
long 
Fneeded32(FLDOCC32 F, FLDLEN32 V)

説明

Fneeded()は、フィールド化バッファに割り当てなければならない領域を決める場合に使用されます。引数Fはフィールドの数、引数Vはすべてのフィールド値に必要な領域のバイト数です。

Fneeded32()は32ビットFMLで使用されます。

マルチスレッドのアプリケーション内のスレッドは、TPINVALIDCONTEXTを含め、どのコンテキスト状態で実行している場合でも、Fneeded()またはFneeded32()を呼び出すことができます。

戻り値

この関数は、エラー発生時に -1を返し、Ferrorを設定してエラー条件を示します。

エラー

次の条件の場合、Fneeded()は異常終了し、Ferrorを次の値に設定します。

[FEINVAL]

関連項目

「FML関数の紹介」、Falloc、Falloc32(3fml)、Fielded、Fielded32(3fml)、Finit、Finit32(3fml)、Fsizeof、Fsizeof32(3fml)、Funused、Funused32(3fml)、Fused、Fused32(3fml)

Fnext、Fnext32(3fml)

名前

Fnext()、Fnext32() - 次のフィールド・オカレンスの取得

形式

#include <stdio.h> 
#include "fml.h" 
 
int 
Fnext(FBFR *fbfr, FLDID *fieldid, FLDOCC *oc, char *value, FLDLEN *len) 
 
#include "fml32.h" 
 
int 
Fnext32(FBFR32 *fbfr, FLDID32 *fieldid, FLDOCC32 *oc, char *value, FLDLEN32 *len) 

説明

Fnext()は、指定されたフィールド・オカレンスの後、バッファ内の次のフィールドを検索します。fbfrは、フィールド化バッファを指すポインタです。fieldidは、フィールド識別子を指すポインタです。ocは、フィールドのオカレンス番号を指すポインタです。valueは、次のフィールドの値を指すポインタです。lenは、次の値の長さです。

フィールド識別子FIRSTFLDIDを指定して、バッファの最初のフィールドを取得する必要があります(たとえば、Fnext()を最初に呼び出すとき)。valueがNULLでない場合、次のフィールド値がvalueにコピーされます。*lenを使用して、値を格納するために十分な領域がバッファに割り当てられているかどうかを判別します。値の長さが*lenに返されます。関数が呼び出されたときにlenがNULLの場合は、十分な領域があるために、新しい値の長さが返されないと想定されます。valueがNULLの場合、値は取得されず、fieldidとocのみが更新されます。*fieldidおよび*ocパラメータはぞれぞれ、次に検出されたフィールドとオカレンスに設定されます。フィールドがそれ以上見つからない場合は、0が返されます(バッファの終わり)。*fieldid、*ocおよび*valueは変更されません。フィールドは、フィールド識別子の順に返されます。

値の型は、char *ですが、返される値は、検索される次のフィールドと同じ型になります。

検索されるフィールドのタイプがFLD_VIEW32である場合、valueパラメータはFVIEWFLD構造体を指します。Fnext()関数を使用して、構造体のvnameフィールドとdataフィールドを設定します。

Fnext32()は32ビットFMLで使用されます。

マルチスレッドのアプリケーション内のスレッドは、TPINVALIDCONTEXTを含め、どのコンテキスト状態で実行している場合でも、Fnext()またはFnext32()を呼び出すことができます。

戻り値

Fnext()は、次のオカレンスを正常に検索できた場合、1を返します。バッファの終わりに達した場合は、0を返します。

この関数は、エラー発生時に -1を返し、Ferrorを設定してエラー条件を示します。

エラー

次の条件の場合、Fnext()は異常終了し、Ferrorを次の値に設定します。

[FALIGNERR]

[FNOTFLD]

[FNOSPACE]

[FEINVAL]

関連項目

「FML関数の紹介」、Fget、Fget32(3fml)、Fnum、Fnum32(3fml)

Fnmid_unload、Fnmid_unload32(3fml)

名前

Fnmid_unload()、Fnmid_unload32() - nm->idマッピング表から領域を取り戻す

形式

#include <stdio.h> 
#include "fml.h" 
void Fnmid_unload(void) 
#include "fml32.h" 
void Fnmid_unload32(void)

説明

Fldid()でロードしたフィールド表が占有しているデータ領域を回復するには、Fnmid_unload()関数を呼び出してファイルをアンロードする必要があります。

Fnmid_unload32()は32ビットFMLで使用されます。

マルチスレッドのアプリケーション内のスレッドは、TPINVALIDCONTEXTを含め、どのようなコンテキスト状態で実行していても、Fnmid_unload()またはFnmid_unload32()を呼び出すことができます。

戻り値

この関数は、void宣言のため何も返しません。

関連項目

「FML関数の紹介」、Fidnm_unload、Fidnm_unload32(3fml)、Fldid、Fldid32(3fml)

Fnum、Fnum32(3fml)

名前

Fnum()、Fnum32() - バッファにあるすべてのオカレンスの数を返す

形式

#include <stdio.h> 
#include "fml.h" 
 
FLDOCC 
Fnum(FBFR *fbfr) 
 
#include "fml32.h" 
 
FLDOCC32 
Fnum32(FBFR *fbfr)

説明

Fnum()は、指定されたバッファに含まれているフィールド数を返します。fbfrはフィールド化バッファを指すポインタです。FLD_FML32およびFLD_VIEW32フィールドは、格納するフィールド数に関係なく、単一フィールドとしてカウントされます。

Fnum32()は32ビットFMLで使用されます。

マルチスレッドのアプリケーション内のスレッドは、TPINVALIDCONTEXTを含め、どのコンテキスト状態で実行している場合でも、Fnum()またはFnum32()を呼び出すことができます。

戻り値

この関数は、エラー発生時に -1を返し、Ferrorを設定してエラー条件を示します。

エラー

次の条件の場合、Fnum()は異常終了し、Ferrorを次の値に設定します。

[FALIGNERR]

[FNOTFLD]

関連項目

「FML関数の紹介」、Foccur、Foccur32(3fml)、Fpres、Fpres32(3fml)

Foccur、Foccur32(3fml)

名前

Foccur()、Foccur32() - バッファにあるフィールド・オカレンスの数を返す

形式

#include <stdio.h> 
#include "fml.h" 
 
FLDOCC 
Foccur(FBFR *fbfr, FLDID fieldid) 
 
#include "fml32.h" 
 
FLDOCC32 Foccur32(FBFR32 *fbfr, FLDID32 fieldid)

説明

Foccur()は、fbfrで参照されるバッファのfieldidで指定されるフィールド・オカレンスの数を決めるために使用されます。FLD_FML32フィールド・タイプであるため、埋め込み型のFML32バッファ内のフィールドのオカレンスはカウントされません。

Foccur32()は32ビットFMLで使用されます。

マルチスレッドのアプリケーション内のスレッドは、TPINVALIDCONTEXTを含め、どのコンテキスト状態で実行している場合でも、Foccur()またはFoccur32()を呼び出すことができます。

戻り値

正常終了の場合、Foccur()は、オカレンスの数を返します。オカレンスがない場合は、0を返します。

この関数は、エラー発生時に -1を返し、Ferrorを設定してエラー条件を示します。

エラー

次の条件の場合、Foccur()は異常終了し、Ferrorを次の値に設定します。

[FALIGNERR]

[FNOTFLD]

[FBADFLD]

関連項目

「FML関数の紹介」、Fnum、Fnum32(3fml)、Fpres、Fpres32(3fml)

Fojoin、Fojoin32(3fml)

名前

Fojoin()、Fojoin32() - ソース・バッファを宛先バッファに組み込む

#include <stdio.h> 
#include "fml.h" 
 
int 
Fojoin(FBFR *dest, FBFR *src) 
 
#include "fml32.h" 
 
int 
Fojoin32(FBFR32 *dest, FBFR32 *src)

説明

Fojoin()は、Fjoin()に似ていますが、宛先バッファdestのフィールドに、ソース・バッファsrcに対応するフィールド識別子/オカレンスがない場合でも、そのフィールドは削除されません。対応するフィールド識別子/オカレンスを宛先バッファに持たないソース・バッファにあるフィールドは、宛先バッファに追加されません。バッファを組み込むことによりFLD_PTRフィールドが削除されても、ポインタによって参照されるメモリー領域は変更または解放されません。

Fjoin()と同様、この関数は領域不足により異常終了し、さらに領域を割り当てた後、操作を完了するために再起動されます。

Fojoin32()は32ビットFMLで使用されます。

マルチスレッドのアプリケーション内のスレッドは、TPINVALIDCONTEXTを含め、どのコンテキスト状態で実行している場合でも、Fojoin()またはFojoin32()を呼び出すことができます。

戻り値

この関数は、エラー発生時に -1を返し、Ferrorを設定してエラー条件を示します。

エラー

次の条件の場合、Fojoin()は異常終了し、Ferrorを次の値に設定します。

[FALIGNERR]

[FNOTFLD]

[FNOSPACE]

例

次に使用例を示します。

if(Fojoin(dest,src) 0)
  F_error("pgm_name");

destが、フィールドA、BおよびCのオカレンスを2個持っており、srcが、フィールドA、CおよびDを持っている場合、結果的に、destは、ソース・フィールド値A、宛先フィールド値B、ソース・フィールド値C、および2番目の宛先フィールド値Cを含んでいます。

関連項目

「FML関数の紹介」、Fconcat、Fconcat32(3fml)、Fjoin、Fjoin32(3fml)、Fproj、Fproj32(3fml)

Fpres、Fpres32(3fml)

名前

Fpres()、Fpres32() - フィールド・オカレンスがバッファにある場合はtrueを返す

#include <stdio.h> 
 
#include "fml.h" 
 
int 
Fpres(FBFR *fbfr, FLDID fieldid, FLDOCC oc) 
 
#include "fml32.h" 
 
int 
Fpres32(FBFR32 *fbfr, FLDID32 fieldid, FLDOCC32 oc)

説明

Fpres()は、指定されたフィールド(fieldid)の指定されたオカレンス(oc)が、fbfrで参照されるバッファに存在するかどうかを調べるために使用されます。Fpres32()は、FLD_FML32フィールド・タイプの埋込み型バッファ内では、指定されたフィールドのオカレンスがあるかどうかをチェックしません。

Fpres32()は32ビットFMLで使用されます。

マルチスレッドのアプリケーション内のスレッドは、TPINVALIDCONTEXTを含め、どのようなコンテキスト状態で実行していても、Fpres()またはFpres32()を呼び出すことができます。

戻り値

Fpres()は、指定されたオカレンスがある場合はtrueを、そうでない場合は、falseを返します。

関連項目

「FML関数の紹介」、Ffind、Ffind32(3fml)、Fnum、Fnum32(3fml)、Foccur、Foccur32(3fml)

Fprint、Fprint32(3fml)

名前

Fprint()、Fprint32() - 標準出力にバッファを出力する

形式

#include <stdio.h> 
#include "fml.h" 
 
int 
Fprint(FBFR *fbfr) 
 
#include "fml32.h" 
 
int 
Fprint32(FBFR32 *fbfr)

説明

Fprint()は、標準出力に指定されたバッファを出力します。fbfrは、フィールド化バッファを指すポインタです。バッファの各フィールドについて、フィールド名とフィールド値がタブで区切って出力されます。Fname()はフィールド名を決定するために使用されます。フィールド名が決定できない場合、フィールド識別子が出力されます。文字列または文字配列のフィールド値内の表示不能な文字は、バックスラッシュとその後に続く2文字の16進値で表現されます。バッファの出力が完了すると改行が出力されます。

FLD_PTR型の値の場合、Fprint32()はフィールド名またはフィールド識別子、およびポインタ値を16進数で出力します。この関数はポインタ情報を出力しますが、Fextread32()関数はFLD_PTRフィールド・タイプを無視します。

FLD_FML32型の値の場合、Fprint32()は各ネスト・レベルに先行タブを追加して、再帰的にFML32バッファを出力します。FLD_VIEW32型の値の場合、Fprint32()はVIEW32フィールド名、および構造体メンバーの名前と値のペアを出力します。

Fprint32()は32ビットFMLで使用されます。

マルチスレッドのアプリケーション内のスレッドは、TPINVALIDCONTEXTを含め、どのようなコンテキスト状態で実行していても、Fprint()またはFprint32()を呼び出すことができます。

戻り値

この関数は、エラー発生時に -1を返し、Ferrorを設定してエラー条件を示します。

エラー

次の条件の場合、Fprint()は異常終了し、Ferrorを次の値に設定します。

[FALIGNERR]

[FNOTFLD]

[FMALLOC]

関連項目

「FML関数の紹介」、Fextread、Fextread32(3fml)、Ffprint、Ffprint32(3fml)、Fname、Fname32(3fml)

Fproj、Fproj32(3fml)

名前

Fproj()、Fproj32() - バッファのプロジェクション

形式

#include <stdio.h> 
#include "fml.h" 
 
int 
Fproj(FBFR *fbfr, FLDID *fieldid) 
 
#include "fml32.h" 
 
int 
Fproj32(FBFR32 *fbfr, FLDID32 *fieldid)

説明

Fproj()は、必要なフィールドのみを維持する目的から、バッファを更新するために使用されます。fbfrは、フィールド化バッファを指すポインタです。必要なフィールドは、fieldidが指すフィールド識別子の配列に指定されます。配列の最後のエントリはBADFLDIDであることが必要です。更新は、その場所で行われます。したがって、投影の結果にないフィールドは、フィールド化バッファから削除されます。フィールド識別子の配列は、再配列される場合があります。(まだ番号順でない場合は、ソートされます。)バッファを更新することによりFLD_PTRフィールドが削除されても、ポインタによって参照されるメモリー領域は変更または解放されません。

Fproj32()は32ビットFMLで使用されます。

マルチスレッドのアプリケーション内のスレッドは、TPINVALIDCONTEXTを含め、どのようなコンテキスト状態で実行していても、Fproj()またはFproj32()を呼び出すことができます。

戻り値

この関数は、エラー発生時に -1を返し、Ferrorを設定してエラー条件を示します。

エラー

次の条件の場合、Fproj()は異常終了し、Ferrorを次の値に設定します。

[FALIGNERR]

[FNOTFLD]

例

#include "fld.tbl.h" 
FBFR *fbfr; 
FLDID fieldid[20]; 
... 
fieldid[0] = A;          /* field ID for field A */ 
fieldid[1] = D;          /* field ID for field D */ 
fieldid[2] = BADFLDID;   /* sentinel value */ 
...  
if(Fproj(fbfr, fieldid)  0) 
    F_error("pgm_name");

バッファが、フィールドA、B、CおよびDを持っている場合、使用例の結果、バッファは、フィールドAおよびDのオカレンスのみ持つようになります。フィールド識別子の配列のエントリは、特定の順番になっている必要はありませんが、フィールド識別子の配列の最後の値は、フィールド識別子0 (BADFLDID)である必要があります。

関連項目

「FML関数の紹介」、Fjoin、Fjoin32(3fml)、Fojoin、Fojoin32(3fml)、Fprojcpy、Fprojcpy32(3fml)

Fprojcpy、Fprojcpy32(3fml)

名前

Fprojcpy()、Fprojcpy32() - バッファのプロジェクションおよびコピー

形式

#include <stdio.h> 
#include "fml.h" 
 
int 
Fprojcpy(FBFR *dest, FBFR *src, FLDID *fieldid) 
 
#include "fml32.h" 
 
int 
Fprojcpy32(FBFR32 *dest, FBFR32 *src, FLDID32 *fieldid)

説明

Fprojcpy()は、Fproj()と類似していますが、プロジェクションはその場所で行われず、宛先バッファで行われます。destは宛先バッファのポインタです。srcは、元のフィールド化バッファを指すポインタです。fieldidは、フィールド識別子の配列を指すポインタです。宛先バッファのすべてのフィールドは、最初に削除され、ソース・バッファに投影した結果は宛先バッファに組み込まれます。ソース・バッファは変更されません。フィールド識別子の配列は、再配列される場合があります。(まだ番号順でない場合は、ソートされます。)バッファを更新することによりFLD_PTRフィールドが削除されても、ポインタによって参照されるメモリー領域は変更または解放されません。

この関数は、領域が不足した場合に異常終了します。この関数は、操作を完了するために付加領域を十分に割り当てた後、再起動されます。

Fprojcpy32()は32ビットFMLで使用されます。

マルチスレッドのアプリケーション内のスレッドは、TPINVALIDCONTEXTを含め、どのようなコンテキスト状態で実行していても、Fprojcpy()またはFprojcpy32()を呼び出すことができます。

戻り値

この関数は、エラー発生時に -1を返し、Ferrorを設定してエラー条件を示します。

エラー

次の条件の場合、Fprojcpy()は異常終了し、Ferrorを次の値に設定します。

[FALIGNERR]

[FNOTFLD]

[FNOSPACE]

関連項目

「FML関数の紹介」、Fjoin、Fjoin32(3fml)、Fojoin、Fojoin32(3fml)、Fproj、Fproj32(3fml)

Fread、Fread32(3fml)

名前

Fread()、Fread32() - フィールド化バッファの読取り

形式

#include <stdio.h> 
#include "fml.h" 
 
int 
Fread(FBFR *fbfr, FILE *iop) 
 
#include "fml32.h" 
 
int 
Fread32(FBFR32 *fbfr, FILE32 *iop)

説明

フィールド化バッファは、Fread()を使用して、ファイル・ストリームから読み取られます。fbfrは、フィールド化バッファを指すポインタです。iopは、FILE型の入力ストリームを指すポインタです(ストリームの詳細は、UNIXシステムのリファレンス・マニュアルでstdio(3S)を参照してください)。Fread()は、ストリームからフィールド化バッファをfbfrに読み込み、バッファに格納されていたデータを消去し、バッファのインデックスを再作成します。Fread32()は、FLD_PTR型のフィールドを無視します。関数にタイプFLD_PTRの値が与えられても、エラーは戻されません。

Fread32()は32ビットFMLで使用されます。

マルチスレッドのアプリケーション内のスレッドは、TPINVALIDCONTEXTを含め、どのコンテキスト状態で実行している場合でも、Fread()またはFread32()を呼び出すことができます。

戻り値

この関数は、エラー発生時に -1を返し、Ferrorを設定してエラー条件を示します。

エラー

次の条件の場合、Fread()は異常終了し、Ferrorを次の値に設定します。

[FALIGNERR]

[FNOTFLD]

[FNOSPACE]

[FEUNIX]

移植性

この関数は、Windows用のOracle Tuxedo System Workstation DLLでは使用できません。

関連項目

「FML関数の紹介」、Findex、Findex32(3fml)、Fwrite、Fwrite32(3fml)

UNIXシステムのリファレンス・マニュアルのstdio(3S)

Frealloc、Frealloc32(3fml)

名前

Frealloc()、Frealloc32() - フィールド化バッファの再割当て

形式

#include <stdio.h> 
#include "fml.h" 
 
FBFR * 
Frealloc(FBFR *fbfr, FLDOCC nf, FLDLEN nv) 
 
#include "fml32.h" 
 
FBFR32 * 
Frealloc32(FBFR32 *fbfr, FLDOCC32 nf, FLDLEN32 nv)

説明

Frealloc()は、フィールド化バッファを拡大するための領域の再割当てに使用されます。fbfrは、フィールド化バッファを指すポインタです。2番目のパラメータnfは、新しいフィールドの数です。3番目のパラメータnvは、新しい値の領域のバイト数です。これらは、増分ではありません。

Frealloc32()は32ビットFMLで使用されます。

マルチスレッドのアプリケーション内のスレッドは、TPINVALIDCONTEXTを含め、どのようなコンテキスト状態で実行していても、Frealloc()またはFrealloc32()を呼び出すことができます。

戻り値

正常終了の場合、Frealloc()は、再割り当てされたFBFRを指すポインタを返します。

この関数は、エラー発生時にNULLを返し、Ferrorを設定してエラー条件を示します。

エラー

次の条件の場合、Frealloc()は異常終了し、Ferrorを次の値に設定します。

[FALIGNERR]

[FNOTFLD]

[FEINVAL]

[FMALLOC]

関連項目

「FML関数の紹介」、Falloc、Falloc32(3fml)、Ffree、Ffree32(3fml)

Frstrindex、Frstrindex32(3fml)

名前

Frstrindex()、Frstrindex32() - バッファにある索引をリストアする

形式

#include <stdio.h> 
#include "fml.h" 
 
int 
Frstrindex(FBFR *fbfr, FLDOCC numidx) 
 
#include "fml32.h" 
 
int 
Frstrindex32(FBFR32 *fbfr, FLDOCC32 numidx)

説明

インデックス解除されたフィールド化バッファは、Findex()またはFrstrindx()を呼び出して再インデックスされます。fbfrは、フィールド化バッファを指すポインタです。前者は、バッファの合計インデックス計算を実行するため、非常にコストがかかります(バッファの完全スキャンが必要)。インデックス化されていなバッファが変更されたとき、またはバッファの前の状態が不明な場合に、使用する必要があります(たとえば、あるプロセスからインデックスなしの別のプロセスに送信された場合)。Frstrindex()は時間がかかりませんが、使用できるのは、前のインデックス解除操作の後でバッファが変更されていない場合のみです。Frstrindx()の2番目の引数numidxは、Funindex()関数の戻り値です。

Frstrindex32()は32ビットFMLで使用されます。

マルチスレッドのアプリケーション内のスレッドは、TPINVALIDCONTEXTを含め、どのコンテキスト状態で実行している場合でも、Frstrindex()またはFrstrindex32()を呼び出すことができます。

戻り値

この関数は、エラー発生時に -1を返し、Ferrorを設定してエラー条件を示します。

エラー

次の条件の場合、Frstrindex()は異常終了し、Ferrorを次の値に設定します。

[FALIGNERR]

[FNOTFLD]

例

バッファを索引なしで送信するためには、次のような文が実行されます。

save = Funindex(fbfr); 
num_to_send = Fused(fbfr); 
transmit(fbfr,num_to_send);        /* A hypothetical function */  Frstrindx(fbfr,save);

これら4つの文は、次のことを実行します。

1. - /* unindex, saving for Frstrindx */ 
2. - /* determine number of bytes to send */ 
3. - /* send fbfr, without index */ 
4. - /* restore index */

この場合、transmit()には、メモリー・ポインタおよび長さが渡されます。送信されるデータは、メモリー・ポインタで始まり、num_to_sendバイトです。いったんバッファが送信されると、その索引は、Frstrindex()を使用してリストアされます(どのような場合でも、transmit()が、索引を変更しないことが前提となっている)。送信の終わりを受信すると、フィールド化バッファを受け取ったプロセスは、Findex()を使用してそのバッファを次に示す方法で索引します。

receive(fbfr); /* get fbfr from wherever .. into fbfr */ 
Findex(fbfr);  /* index it */

受信プロセスは、次の理由によりFrstrindx()を呼び出すことができません。