Difference between revisions of "SAVEOBJECT()"

From Recital Documentation Wiki
Jump to: navigation, search
 
(One intermediate revision by one user not shown)
Line 1: Line 1:
{{YLM to do}}
 
 
 
==Purpose==
 
==Purpose==
 
Function to save an object or dynamic array to an external .obf file
 
Function to save an object or dynamic array to an external .obf file
Line 10: Line 8:
  
 
==See Also==
 
==See Also==
[[ADDPROPERTY()]], [[ARRAY()]], [[CLASS - Methods]], [[CLASS - Parameters]], [[CLASS - Properties]], [[CLASS - Scoping]], [[CREATEOBJECT()]], [[DEFINE CLASS]], [[DISPLAY CLASSES]], [[DODEFAULT()]], [[LIST CLASSES]], [[LOADOBJECT()]], [[METHOD]], [[NEWOBJECT()]], [[OBJECT()]], [[REMOVEPROPERTY()]]
+
[[ACLASS()]], [[ADDPROPERTY()]], [[AMEMBERS()]], [[CLASS]], [[CLASS - Methods]], [[CLASS - Parameters]], [[CLASS - Properties]], [[CLASS - Scoping]], [[COMPOBJ()]], [[CREATEOBJECT()]], [[DEFINE CLASS]], [[DISPLAY CLASSES]], [[DODEFAULT()]], [[FOREACH]], [[LIST CLASSES]], [[LOADOBJECT()]], [[METHOD]], [[NEWOBJECT()]], [[OBJECT()]], [[PRINT_HTML()]], [[PRINT_JSON()]], [[PRINT_R()]], [[PRINT_XML()]], [[REMOVEPROPERTY()]], [[REQUIRE_ONCE()]], [[SQL SELECT]], [[WITH]]
  
  
 
==Description==
 
==Description==
The SAVEOBJECT() function is used to save an object or dynamic array to an external .obf file.  The <object> is the name of the object and <expC> is the name of the file.  If the file extension is not specififed, '.obf' is assumed.  The SAVEOBJECT() function returns .T. (true) if the object is successfully saved.
+
The SAVEOBJECT() function is used to save an object or dynamic array to an external .obf file.  The <object> is the name of the object and <expC> is the name of the target file.  If the file extension is not specififed, '.obf' is assumed.  The SAVEOBJECT() function returns .T. (true) if the object is successfully saved.
  
The built-in ''save'' class method can also be used to save an object to an external .obf file.
+
The built-in ''save'' [[CLASS - Methods|class method]] can also be used to save an object to an external .obf file.  Similarly, the LOADOBJECT() function can be used to restore an object or dynamic array from an external .obf file and objects have access to the built-in ''load'' [[CLASS - Methods|class method]].
 
   
 
   
  
 
==Example==
 
==Example==
 
<code lang="recital">
 
<code lang="recital">
open database southwind
+
class myclass
select * from shippers into object shipobj
+
...
saveobject(shipobj,"shippers")
+
endclass
 +
 
 +
obj1 = new myclass()
 +
saveobject(obj1,"file1")
 +
// or
 +
obj1.save("file1")
 
</code>
 
</code>
  

Latest revision as of 15:12, 14 December 2009

Purpose

Function to save an object or dynamic array to an external .obf file


Syntax

SAVEOBJECT(<object>, <expC>)


See Also

ACLASS(), ADDPROPERTY(), AMEMBERS(), CLASS, CLASS - Methods, CLASS - Parameters, CLASS - Properties, CLASS - Scoping, COMPOBJ(), CREATEOBJECT(), DEFINE CLASS, DISPLAY CLASSES, DODEFAULT(), FOREACH, LIST CLASSES, LOADOBJECT(), METHOD, NEWOBJECT(), OBJECT(), PRINT_HTML(), PRINT_JSON(), PRINT_R(), PRINT_XML(), REMOVEPROPERTY(), REQUIRE_ONCE(), SQL SELECT, WITH


Description

The SAVEOBJECT() function is used to save an object or dynamic array to an external .obf file. The <object> is the name of the object and <expC> is the name of the target file. If the file extension is not specififed, '.obf' is assumed. The SAVEOBJECT() function returns .T. (true) if the object is successfully saved.

The built-in save class method can also be used to save an object to an external .obf file. Similarly, the LOADOBJECT() function can be used to restore an object or dynamic array from an external .obf file and objects have access to the built-in load class method.


Example

class myclass
...
endclass
 
obj1 = new myclass()
saveobject(obj1,"file1")
// or
obj1.save("file1")


Products

Recital, Recital Server