Difference between revisions of "OBJECTWRITE()"

From Recital Documentation Wiki
Jump to: navigation, search
 
(One intermediate revision by one user not shown)
Line 1: Line 1:
==Class==
 
Binary File Access
 
 
 
 
==Purpose==
 
==Purpose==
 
Function to write an external binary file from an object field
 
Function to write an external binary file from an object field
Line 33: Line 29:
  
 
==Products==
 
==Products==
Recital Database Server, Recital Mirage Server, Recital Terminal Developer
+
Recital, Recital Server
 
[[Category:Documentation]]
 
[[Category:Documentation]]
 
[[Category:Functions]]
 
[[Category:Functions]]
 
[[Category:Binary File Access]]
 
[[Category:Binary File Access]]
 
[[Category:Binary File Access Functions]]
 
[[Category:Binary File Access Functions]]

Latest revision as of 17:29, 3 December 2009

Purpose

Function to write an external binary file from an object field


Syntax

OBJECTWRITE(<filename>,<object field>[,<expL>])


See Also

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


Description

The OBJECTWRITE() function writes an external binary file from a Recital Object field. The OBJECTWRITE() function returns .T. if the external binary file was created successfully, and .F. otherwise.

The name of the file to create can be specified in the parameter <filename>. This can be any valid Recital/4GL expression that returns a valid filename. The filename can also be an empty string, providing that the logical expression <expL> is true (.T.). In this case, a unique temporary file name will be generated and the Object written to this file, with the file name being returned from OBJECTWRITE().

The Recital object field containing the data to be written, is specified in the parameter <object field>, and must be a valid field in the currently selected workarea.


Example

? objectwrite("myicon.gif",ICONS)
.T.
? objectwrite("",PHOTO,.T.)
_0049e10001.gif


Products

Recital, Recital Server