Difference between revisions of "OBJECTREAD()"

From Recital Documentation Wiki
Jump to: navigation, search
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
==Class==
 
Binary Objects
 
 
 
 
==Purpose==
 
==Purpose==
 
Function to read an external binary file into an object field
 
Function to read an external binary file into an object field
Line 18: Line 14:
 
The OBJECTREAD() function reads an external binary file into a Recital Object field.  It returns .T. if the operation was successful, and .F. otherwise.  
 
The OBJECTREAD() function reads an external binary file into a Recital Object field.  It returns .T. if the operation was successful, and .F. otherwise.  
  
The file to read in is specified in <filename>, and can be any valid Recital/4GL expression that returns a valid file name. The first three characters of the file extension are stored in the Object field as the Objects type, as returned by the OBJECTTYPE() function.
+
The file to read in is specified in <filename>, and can be any valid Recital/4GL expression that returns a valid file name. The first three characters of the file extension are stored in the Object field as the object's type, as returned by the OBJECTTYPE() function.
  
 
The field into which the file is placed is specified in <object field>, and must be a Recital Object field in the currently selected workarea.
 
The field into which the file is placed is specified in <object field>, and must be a Recital Object field in the currently selected workarea.
Line 31: Line 27:
  
 
==Products==
 
==Products==
Recital Database Server, Recital Mirage Server, Recital Terminal Developer
+
Recital, Recital Server
 
[[Category:Documentation]]
 
[[Category:Documentation]]
 
[[Category:Functions]]
 
[[Category:Functions]]
[[Category:Binary Objects]]
+
[[Category:Binary File Access]]
[[Category:Binary Objects Functions]]
+
[[Category:Binary File Access Functions]]

Latest revision as of 12:39, 17 March 2010

Purpose

Function to read an external binary file into an object field


Syntax

OBJECTREAD(<filename>,<object field>)


See Also

BINCREATE(), BINCLOSE(), BINOPEN(), BINREAD(), BINWRITE(), OBJECTTYPE(), OBJECTWRITE()


Description

The OBJECTREAD() function reads an external binary file into a Recital Object field. It returns .T. if the operation was successful, and .F. otherwise.

The file to read in is specified in <filename>, and can be any valid Recital/4GL expression that returns a valid file name. The first three characters of the file extension are stored in the Object field as the object's type, as returned by the OBJECTTYPE() function.

The field into which the file is placed is specified in <object field>, and must be a Recital Object field in the currently selected workarea.


Example

? objectread('images/brickwall.gif',WALLPAPER)
.T.


Products

Recital, Recital Server