pg_lo_read
Prev | 4.6.Large Object Processing Commands | Next

## pg_lo_read

pg_lo_read — 巨大対象から読出す Read from a large object

## 構文 Synopsis

    pg_lo_read conn descriptor bufVar len

## 説明 Description

`pg_lo_read` は巨大対象から名前が `bufVar` の変数内に､最大限 `len` バイト読む｡ `pg_lo_read` reads at most `len` bytes from a large object into a variable named `bufVar`.

## 引数 Arguments

`conn`

  接続の把持子｡ 　 The handle of the connection.

`descriptor`

  pg_lo_open からの巨大対象に関する記述子｡ A descriptor for the large object from pg_lo_open.

`bufVar`

  巨大対象の区分を含むべき変数緩衝域の名前 The name of a buffer variable to contain the large object segment.

`len`

  読むべきバイトの最大個数｡ The maximum number of bytes to read.

## 返り値 Return Value

実際に読まれたバイトの個数が返される; これは､もし巨大対象の末尾が先に到達されると､要求された数より小さいかもしれない｡ The number of bytes actually read is returned; this could be less than the number requested if the end of the large object is reached first.

巨大対象から読み出しに不都合が生じると負数が返される｡その他の不都合はTcl 不都合発生の結果になる｡註意すべきは､この命令の不都合取扱いは他の多くの巨大対象命令とは異なる｡ If an error occurs reading from the large object, a negative number will be returned. Other errors result in a Tcl error being thrown. Note that error handling for this command is different from most of the other Large Object commands.

## 註意 Notes

全ての巨大対象操作は SQL 一括処理内部で行われなければならない｡ All large object manipulation must take place within an SQL transaction block.

この命令は PostgreSQL libpq function `lo_read`を使い模擬する｡ This command uses or emulates the PostgreSQL libpq function `lo_read`.

Prev | Up | Next
pg_lo_close | Home | pg_lo_write