See Also

Work Class  | Work Members

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

Language

Visual Basic

C#

C++

C++/CLI

Show All

objectToScript
options
See Also Languages RedGate.SQLCompare.Engine Send comments on this topic.

ScriptObject Method

RedGate.SQLCompare.Engine Namespace > Work Class : ScriptObject Method (Work)

Returns the script necessary to create a SQL object.

[Visual Basic]
Public Function ScriptObject( _    ByVal objectToScript As IDatabaseObject, _    ByVal options As Options _ ) As Regions
[C#]
public Regions ScriptObject(    IDatabaseObject objectToScript,    Options options );
[C++]
public: Regions* ScriptObject(    IDatabaseObject* objectToScript,    Options options )
[C++/CLI]
public: Regions^ ScriptObject(    IDatabaseObject^ objectToScript,    Options options )

Parameters

objectToScript
options

Return Type

A Regions collection containing batches of SQL script.

Remarks

This creates SQL code used to create an object such as a table, view, or stored procedure.

Example

[C#] 

Database db=new Database(); 
  
db.Register(new ConnectionProperties(".", "WidgetStaging"), Options.Default); 
  
Work work=new Work(); 
  
//get the script for an object 
Regions regions=work.ScriptObject(db.Tables[0], Options.Default); 
  
Console.WriteLine("SQL script:\n{0}", regions.ToString()); 
  
db.Dispose(); 
    

[Visual Basic] 

Dim db As New Database()

db.Register(New ConnectionProperties(".", "WidgetStaging"), Options.Default)

Dim work As New Work()

'get the script for an object

Dim regions As Regions = work.ScriptObject(db.Tables(0), Options.Default)

Console.WriteLine("SQL script:")
Console.WriteLine("{0}", regions.ToString())

'dispose
db.Dispose()

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also

Work Class  | Work Members

 

 


© 2003 - 2007 Red Gate Software Ltd. All Rights Reserved.