Difference between revisions of "OBJECTREAD()"

From Lianjapedia
Jump to: navigation, search
m (1 revision)
 
(5 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
==Purpose==
 
==Purpose==
 
Function to read an external binary file into an object field
 
Function to read an external binary file into an object field
 
  
 
==Syntax==
 
==Syntax==
 
OBJECTREAD(<filename>,<object field>)
 
OBJECTREAD(<filename>,<object field>)
 
  
 
==See Also==
 
==See Also==
[[BINCREATE()]], [[BINCLOSE()]], [[BINOPEN()]], [[BINREAD()]], [[BINWRITE()]], [[OBJECTTYPE()]], [[OBJECTWRITE()]]
+
[[BINCREATE()]], [[BINCLOSE()]], [[BINOPEN()]], [[BINREAD()]], [[BINWRITE()]], [[OBJECTSIZE()]], [[OBJECTTYPE()]], [[OBJECTWRITE()]]
 
+
  
 
==Description==
 
==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 OBJECTREAD() function reads an external binary file into an 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 file to read in is specified in <filename>, and can be any valid 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 an Object field in the currently selected workarea.
  
 
==Example==
 
==Example==
Line 25: Line 21:
 
</code>
 
</code>
  
 
==Products==
 
Recital, Recital Server
 
 
[[Category:Documentation]]
 
[[Category:Documentation]]
 
[[Category:Functions]]
 
[[Category:Functions]]
[[Category:Binary File Access]]
+
[[Category:Object Storage Functions]]
[[Category:Binary File Access Functions]]
+
[[Category:Lianja VFP Extensions]]
 +
[[Category:VFP Function Extensions]]

Latest revision as of 08:27, 4 February 2013

Purpose

Function to read an external binary file into an object field

Syntax

OBJECTREAD(<filename>,<object field>)

See Also

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

Description

The OBJECTREAD() function reads an external binary file into an 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 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 an Object field in the currently selected workarea.

Example

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