表20-5は、この項で説明しているファイルI/Oインタフェース関数を示しています。
表20-5 ファイルI/Oインタフェース関数
関数 | 用途 |
---|---|
|
オープンされているファイルをクローズします。 |
|
ファイルの存在を確認するためにテストします。 |
|
バッファ・データをファイルに書き込みます。 |
|
ファイルの長さを取得します。 |
|
OCIFileパッケージを初期化します。 |
|
ファイルをオープンします。 |
|
ファイルからバッファにデータを読み取ります。 |
|
ファイルの現行の位置を変更します。 |
|
OCIFileパッケージを終了します。 |
|
|
関連項目: これらの関数の使用方法の詳細は、『Oracle Database データ・カートリッジ開発者ガイド』を参照してください。 |
OCIFileObject
データ構造には、ファイルのオープン方法およびオープンしてからそのファイルへアクセスする方法に関する情報が保持されています。この構造をOCIFileOpen()
で初期化すると、ファイルで実行可能な操作によって識別子となります。このパラメータは、オープンされているファイルで実行するすべての機能に必要です。このデータ構造はOCIFileクライアントには不透明です。これはOCIFileOpen()で初期化し、OCIFileClose()で終了します。
パラメータ
OCI環境ハンドルまたはユーザー・セッション・ハンドルです。
OCIエラー・ハンドルです。エラーがある場合は、err
に記録され、OCI_ERROR
が戻されます。OCIErrorGet()のコールによって診断情報を取得できます。
クローズされるファイル識別子へのポインタです。
パラメータ
OCI環境ハンドルまたはユーザー・セッション・ハンドルです。
OCIエラー・ハンドルです。エラーがある場合は、err
に記録され、OCI_ERROR
が戻されます。OCIErrorGet()のコールによって診断情報を取得できます。
NULL
で終了する文字列のファイル名です。
NULL
で終了する文字列のファイルのパスです。
ファイルが存在する場合はTRUE
に設定し、それ以外の場合はFALSE
に設定します。
パラメータ
OCI環境ハンドルまたはユーザー・セッション・ハンドルです。
OCIエラー・ハンドルです。エラーがある場合は、err
に記録され、OCI_ERROR
が戻されます。OCIErrorGet()のコールによって診断情報を取得できます。
ファイルを参照する一意のファイル識別子です。
構文
sword OCIFileGetLength( void *hndl, OCIError *err, OraText *filename, OraText *path, ubig_ora *lenp );
パラメータ
OCI環境ハンドルまたはユーザー・セッション・ハンドルです。
OCIエラー・ハンドルです。エラーがある場合は、err
に記録され、OCI_ERROR
が戻されます。OCIErrorGet()のコールによって診断情報を取得できます。
NULL
で終了する文字列のファイル名です。
NULL
で終了する文字列のファイルのパスです。
バイトで示したバッファの長さに設定します。
パラメータ
OCI環境ハンドルまたはユーザー・セッション・ハンドルです。
OCIエラー・ハンドルです。エラーがある場合は、err
に記録され、OCI_ERROR
が戻されます。OCIErrorGet()のコールによって診断情報を取得できます。
構文
sword OCIFileOpen( void *hndl, OCIError *err, OCIFileObject **filep, OraText *filename, OraText *path, ub4 mode, ub4 create, ub4 type );
パラメータ
OCI環境ハンドルまたはユーザー・セッション・ハンドルです。
OCIエラー・ハンドルです。エラーがある場合は、err
に記録され、OCI_ERROR
が戻されます。OCIErrorGet()のコールによって診断情報を取得できます。
ファイル識別子です。
NULL
で終了する文字列のファイル名です。
NULL
で終了する文字列のファイルのパスです。
ファイルをオープンするモードです。次のモードが有効です。
OCI_FILE_READ_ONLY
OCI_FILE_WRITE_ONLY
OCI_FILE_READ_WRITE
ファイルが存在しない場合に作成するかどうか指定します。次の値が有効です。
OCI_FILE_TRUNCATE
— ファイルをその存在の有無に関係なく作成します。ファイルが存在する場合は、既存のファイルが上書きされます。
OCI_FILE_EXCL
— ファイルが存在する場合は失敗し、存在しない場合はファイルが作成されます。
OCI_FILE_CREATE
— ファイルが存在する場合はそのファイルをオープンし、存在しない場合はファイルが作成されます。
OCI_FILE_APPEND
— 書込みの前にファイルの終わりへのファイル・ポインタを設定します。このフラグは、OCI_FILE_CREATE
で論理演算子ORとともに使用できます。
ファイルの型。次の値が有効です。
OCI_FILE_TEXT
OCI_FILE_BIN
OCI_FILE_STDIN
OCI_FILE_STDOUT
OCI_FILE_STDERR
構文
sword OCIFileRead( void *hndl, OCIError *err, OCIFileObject *filep, void *bufp, ub4 bufl, ub4 *bytesread );
パラメータ
OCI環境ハンドルまたはユーザー・セッション・ハンドルです。
OCIエラー・ハンドルです。エラーがある場合は、err
に記録され、OCI_ERROR
が戻されます。OCIErrorGet()のコールによって診断情報を取得できます。
ファイルを参照する一意のファイル識別子です。
データの読取り先バッファへのポインタです。bufl
のメモリー長が割り当てられるとみなされます。
バイトで示したバッファの長さです。
読取りバイト数です。
構文
sword OCIFileSeek( void *hndl, OCIError *err, OCIFileObject *filep, uword origin, ubig_ora offset, sb1 dir );
パラメータ
OCI環境ハンドルまたはユーザー・セッション・ハンドルです。
OCIエラー・ハンドルです。エラーがある場合は、err
に記録され、OCI_ERROR
が戻されます。OCIErrorGet()のコールによって診断情報を取得できます。
ファイルを参照する一意のファイル識別子です。
検索の開始地点です。次のいずれかの値を使用します。
OCI_FILE_SEEK_BEGINNING
(先頭)
OCI_FILE_SEEK_CURRENT
(現行の位置)
OCI_FILE_SEEK_END
(EOF)
読取り開始地点からのバイト数です。
開始地点から移動する方向です。
注意: 方向はOCIFILE_FORWARD またはOCIFILE_BACKWARD のいずれかです。 |
パラメータ
OCI環境ハンドルまたはユーザー・セッション・ハンドルです。
OCIエラー・ハンドルです。エラーがある場合は、err
に記録され、OCI_ERROR
が戻されます。OCIErrorGet()のコールによって診断情報を取得できます。
構文
sword OCIFileWrite( void *hndl, OCIError *err, OCIFileObject *filep, void *bufp, ub4 buflen, ub4 *byteswritten );
パラメータ
OCI環境ハンドルまたはユーザー・セッション・ハンドルです。
OCIエラー・ハンドルです。エラーがある場合は、err
に記録され、OCI_ERROR
が戻されます。OCIErrorGet()のコールによって診断情報を取得できます。
ファイルを参照する一意のファイル識別子です。
データの書込み元バッファへのポインタです。buflen
のメモリー長が割り当てられるとみなされます。
バイトで示したバッファの長さです。
書込みバイト数です。