SqlSmoObject.Initialize Method (Boolean)

Initializes the object and forces the properties be loaded.

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

Syntax

'Declaration
Public Function Initialize ( _
    allProperties As Boolean _
) As Boolean
public bool Initialize (
    bool allProperties
)
public:
bool Initialize (
    bool allProperties
)
public boolean Initialize (
    boolean allProperties
)
public function Initialize (
    allProperties : boolean
) : boolean

Parameters

  • allProperties
    A Boolean value that specifies whether to load all the property values.

    If True, the property values are loaded.

    If False, the property values are not loaded.

Return Value

A Boolean value that specifies whether the object initialized successfully. If True, the object initialized successfully. If False, the object did not initialize successfully.

Remarks

Updated text:

This method initializes an object and loads its properties. SMO does not automatically load all the properties when the object is constructed. Whether the property is loaded initially depends on the IsExpensive property and the default initialization fields. Otherwise, properties are loaded automatically when they are specifically referenced in the code, or when the Initialize method is called.

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

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

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

See Also

Reference

SqlSmoObject Class
SqlSmoObject Members
Microsoft.SqlServer.Management.Smo Namespace

Change History

Release

History

New content:
  • Added description of the Initialize method to Remarks.

Overview

How to: Set Default Initialization Fields in Visual Basic .NET

How to: Use an SMO Method with a Parameter in Visual Basic .NET