DtsProperty.GetValue Method

Article
12/03/2008

Returns the value of the property.

Namespace: Microsoft.SqlServer.Dts.Runtime
Assembly: Microsoft.SqlServer.ManagedDTS (in microsoft.sqlserver.manageddts.dll)

Syntax

'Declaration
Public Function GetValue ( _
    o As Object _
) As Object

public Object GetValue (
    Object o
)

public:
Object^ GetValue (
    Object^ o
)

public Object GetValue (
    Object o
)

public function GetValue (
    o : Object
) : Object

Parameters

o
The parent object of the property whose value is to be returned.

Return Value

An object that contains the value of the property.

Remarks

Updated text:17 July 2006

When you request the value of a property by calling the GetValue method, the object that you must pass as a parameter is the object to which the property belongs. For example, if you are working with an OLE DB connection manager as shown in the following example, and you have created a DtsProperty object for its ServerName property, then you would pass the connection manager object as the parameter to the GetValue method.

Example

using System;
using Microsoft.SqlServer.Dts.Runtime;

namespace DtsPropertyGetValueCS
{
  class Program
  {
    static void Main(string[] args)
    {
      Package testPackage;
      ConnectionManager testConnection;
      DtsProperty testProperty;
      string propertyValue;

      testPackage = new Package();
      testConnection = testPackage.Connections.Add("OLEDB");
      testConnection.ConnectionString = "Provider=SQLOLEDB;" +
        "Data Source=(local);Initial Catalog=AdventureWorks;" +
        "Integrated Security=SSPI";
      testConnection.Name = "Test Connection Manager";

      testProperty = testConnection.Properties["ServerName"];
      propertyValue = testProperty.GetValue(testConnection).ToString();

      Console.WriteLine("The value of ServerName is: " + propertyValue);
      Console.Read();

    }
  }
}

Imports Microsoft.SqlServer.Dts.Runtime

Module Module1

  Sub Main()

    Dim testPackage As Package
    Dim testConnection As ConnectionManager
    Dim testProperty As DtsProperty
    Dim propertyValue As String

    testPackage = New Package()
    testConnection = testPackage.Connections.Add("OLEDB")
    testConnection.ConnectionString = "Provider=SQLOLEDB;" & _
      "Data Source=(local);Initial Catalog=AdventureWorks;" & _
      "Integrated Security=SSPI"
    testConnection.Name = "Test Connection Manager"

    testProperty = testConnection.Properties("ServerName")
    propertyValue = testProperty.GetValue(testConnection).ToString()

    Console.WriteLine("The value of ServerName is: " & propertyValue)
    Console.Read()

  End Sub

End Module

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