AuditSpecification.Script Method (ScriptingOptions)

Article
08/11/2014

Generates a Transact-SQL script that can be used to re-create the audit specification as specified by the script options.

Namespace: Microsoft.SqlServer.Management.Smo
Assembly: Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)

Syntax

'Declaration
Public Function Script ( _
    scriptingOptions As ScriptingOptions _
) As StringCollection
'Usage
Dim instance As AuditSpecification 
Dim scriptingOptions As ScriptingOptions 
Dim returnValue As StringCollection 

returnValue = instance.Script(scriptingOptions)

public StringCollection Script(
    ScriptingOptions scriptingOptions
)

public:
virtual StringCollection^ Script(
    ScriptingOptions^ scriptingOptions
) sealed

abstract Script : 
        scriptingOptions:ScriptingOptions -> StringCollection  
override Script : 
        scriptingOptions:ScriptingOptions -> StringCollection

public final function Script(
    scriptingOptions : ScriptingOptions
) : StringCollection

Parameters

scriptingOptions
Type: Microsoft.SqlServer.Management.Smo.ScriptingOptions
A ScriptingOptions object value that is used to specify the script options.

Return Value

Type: System.Collections.Specialized.StringCollection
A StringCollection system object value that contains a list of Transact-SQL statements in the script.

Implements

IScriptable.Script(ScriptingOptions)

Remarks

The generated script might contain undocumented, internal procedures, which are required for the complete script output.

Examples

'Connect to the local, default instance of SQL Server.
Dim srv As Server
srv = New Server
'Reference the AdventureWorks2012 database.
Dim db As Database
db = srv.Databases("AdventureWorks2012")
'Define a Scripter object and set the required scripting options.
Dim scrp As Scripter
scrp = New Scripter(srv)
scrp.Options.ScriptDrops = False
scrp.Options.WithDependencies = True
'Iterate through the tables in database and script each one. Display the script.
'Note that the StringCollection type needs the System.Collections.Specialized namespace to be included.
Dim tb As Table
Dim smoObjects(1) As Urn
For Each tb In db.Tables
    smoObjects = New Urn(0) {}
    smoObjects(0) = tb.Urn
    If tb.IsSystemObject = False Then
        Dim sc As StringCollection
        sc = scrp.Script(smoObjects)
        Dim st As String
        For Each st In sc
            Console.WriteLine(st)
        Next
    End If
Next

Share via