Difference between revisions of "OBJECTREAD()"
Yvonne.milne (Talk | contribs) m (1 revision) |
|||
| 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== | ||
| Line 17: | Line 14: | ||
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. | ||
| − | |||
==Example== | ==Example== | ||
| Line 25: | Line 21: | ||
</code> | </code> | ||
| − | |||
| − | |||
| − | |||
[[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]] | ||
Revision as of 09:28, 14 November 2012
Contents
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 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.
