ExportCollection method (WinStudio scripts)

Applies To

IWSIDOCollection interface

Definition

Exports the contents of a designated IDO collection to a file.

Parallels the Form menu option Export to File.

Syntax

object.ExportCollection( Boolean1, string, Boolean2 )

  Part   Description
object Required. A reference to an IDO collection.
Boolean1 Required. Boolean value that indicates how the output is to be delimited:
  • TRUE means that the output is to be tab-delimited.
  • FALSE means that the output is to be comma-delimited.
string Required. The path and name of the output file.

If you do not specify a full path, the path is relative to the file in which WinStudio.exe is installed.

This method does not create directories.

Boolean2 Required. Boolean value that indicates whether record caps are to be ignored or honored:
  • TRUE signifies that the system is to ignore any record cap and return all records in the collection. This effectively overrides (for this action) any record cap set for the system or by the user.
  • FALSE signifies that the system is to return only the number of records specified by any record caps in effect on the user's system.

Example

Sub Main()
    ThisForm.PrimaryIDOCollection.ExportCollection(False, "c:\mytemp\Export.csv", False)
End Sub