Server.GetPropertyNames Method

Article
12/03/2008

Returns the names of the initialized properties for the specified object type

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

Syntax

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

public StringCollection GetPropertyNames (
    Type typeObject
)

public:
StringCollection^ GetPropertyNames (
    Type^ typeObject
)

public StringCollection GetPropertyNames (
    Type typeObject
)

public function GetPropertyNames (
    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 property names for the specified object.

Remarks

Updated text:

SMO optimization allows only the minimum properties to be loaded when an object is created. You can use this method to see which properties are currently initialized for an object at any point in your 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
'Display all the loaded properties for the Server type.
Dim s As String
Console.WriteLine("===Before State property is accessed.===")
For Each s In srv.GetPropertyNames(srv.GetType)
    Console.WriteLine(s.ToString)
Next
'Access the State property of the Server object.
Console.WriteLine(srv.State)
'Again, display the loaded properties for the Server type.
Console.WriteLine("===After State property is accessed.===")
    For Each s In srv.GetPropertyNames(srv.GetType)
    Console.WriteLine(s.ToString)
Next

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