Copy_Row_To_OS subroutine [Revelation On-Line Wiki]

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Copy_Row_To_OS subroutine   ======


 
==== Description ====
 
Copies one or more native table rows to operating system files.
 
==== Syntax ====
 
**Copy_Row_To_OS**(//scrtablename//, //scrkeylist//, //destfilelist//, //overwriteflag//, c//onvertflag//, //lockflag)//
 
==== Parameters ====
 
The Copy_Row_To_OS routine has the following parameters.

^Parameter^Description^^
|//scrtablename//|Specifies the name of the source table.||
|//scrkeylist//|Specifies a list of source keys to copy to operating system files. A one-to-one correspondence must exist between //destfilelist// and //scrkeylist//.\\ \\ Note:  If more than one rows are to be copied, separate the keys with field marks.||
|//destfilelist//|Specifies a destination operating system file or list of destination files. The file name includes the operating system drive and path. A one-to-one correspondence must exist between //destfilelist// and //scrkeylist//.\\ \\ If //destfilelist// is null, //scrkeylist// is used; the default directory is the OpenInsight directory.||
|//overwriteflag//|Determines whether or not to overwrite existing rows.\\ \\ __Value__ __Description__\\ 0 - Do not overwrite (default).\\ 1 - Only replace an existing file. If the destination file does not exist, then skip the row.\\ 2 - Write this file, unconditionally. If the destination file exists, overwrite it.|
|//convertflag//|//convertflag// determines whether or not to convert field marks to carriage return/linefeed characters. If //convertflag// is null, the default is to perform the conversion (0). When copying compiled scripts or other binary data, always suppress the conversion by setting the convertflag.\\ \\ __Value__ __Description__\\ 0 - Perform conversion (default).\\ 1 - Do not perform conversion.|
|//lockflag//|Determines whether or not to lock the source rows and destination files during the copy operation.\\ \\ __Value__ __Description__\\ 0 - No locking (default).\\ 1 - Lock.|

 
==== See Also ====
 
[[copy_os_to_row|Copy_OS_To_Row]], [[copy_row|Copy_Row]]


==== Example ====

(From System Monitor) The following example illustrates how to copy OpenInsight rows to operating system files from the command line:

<code>
run Copy_Row_To_OS "SYSOBJ", "$TEST_PROC", "C:\DAT\PROC1","", 1
</code>