Whitebeam Object Definition

Site Map
 
Home
 
Application Guide
Reference
  Installation
  Configuration
  XML Markup
  JavaScript Classes
  ROM
  Templates
  Environment
  Dev Process
  Tools
  External Links
  Example libraries
Community
Contact Whitebeam
To-Do
Download
Credits
Licence
Whitebeam Users
 
 
 

Whitebeam Object Definition

Method Description

PgsqlConnection.createLargeObject()

Create a new Large Object in the Postgres Database.

See Also

PgsqlConnection, PgsqlResult, Binary

Syntax

Binary = PgsqlConnection.createLargeObject(mode)

Parameters

The 'PgsqlConnection.createLargeObject' method takes 1 parameter:

Name Type/Value Range/Length Description
modenumber  Required. 1=read, 2=write, 3=read/write

Results

The 'PgsqlConnection.createLargeObject' method returns Binary:

Type/Value Range/Length Description
Binary   Returns a specialised Binary object openned for writing.

Remarks

Creates a new Postgres Large Object (LOB) for reading and/or writing.

If the object is successfully created then the method returns a specialised binary object. The standard binary object methods (read/write) can be used on the resulting object, so for example to write contents to the binary object use 'binObj.write'.

If the object cannot be created then 'null' is returned to the caller

As well as the standard binary object methods and attributes the Binary object created by this call will have the following attributes:

AttributeDescription
sizeofThe actual size of the existing Large Object when openned. Note that this does not change as you write to the object. It is the size when openned.
oidThe Postgres OID for the open object (more useful when the new LO has just been created).

Note that the large object is only valid until the database is closed, or the next call to 'connection.exec' is made.

Whitebeam release 1.3.36
(loadtime : 9ms)