Server.GetDefaultInitFields Method

Article
12/03/2008

Returns the property types that are initialized by default when the specified object is initialized.

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

Syntax

'Declaration
Public Function GetDefaultInitFields ( _
    typeObject As Type _
) As StringCollection

public StringCollection GetDefaultInitFields (
    Type typeObject
)

public:
StringCollection^ GetDefaultInitFields (
    Type^ typeObject
)

public StringCollection GetDefaultInitFields (
    Type typeObject
)

public function GetDefaultInitFields (
    typeObject : Type
) : StringCollection

Parameters

typeObject
A Type system object that specifies the type of object.

Return Value

A StringCollection system object that contains a list of property types that are initialized by default when the specified object is initialized.

Remarks

Updated text:

This method is used to control the way in which object properties are initialized in an SMO application. You can use this method to optimize your SMO application.

This namespace, class, or member is supported only in version 2.0 of the Microsoft .NET Framework.

Example

'Connect to the local, default instance of SQL Server.
Dim srv As Server
srv = New Server
'Reference the AdventureWorks database.
Dim db As Database
db = srv.Databases("AdventureWorks")
'Assign the Table object type to a System.Type object variable.
Dim tb As Table
Dim typ As Type
tb = New Table
typ = tb.GetType
'Assign the current default initialization fields for the Table object type to a 
'StringCollection object variable.
Dim sc As StringCollection
sc = srv.GetDefaultInitFields(typ)
'Set the default initialization fields for the Table object type to the CreateDate property.
srv.SetDefaultInitFields(typ, "CreateDate")
'Retrieve the Schema, Name, and CreateDate properties for every table in AdventureWorks.
'Note that the improvement in performance can be viewed in SQL Profiler.
For Each tb In db.Tables
    Console.WriteLine(tb.Schema + "." + tb.Name + " " + tb.CreateDate)
Next
'Set the default initialization fields for the Table object type back to the original settings.
srv.SetDefaultInitFields(typ, sc)

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms