ScriptTask.ReadOnlyVariables Property

Article
12/03/2008

Gets or sets the comma-delimited list of existing variables made available to the package by the user for read-only access.

Namespace: Microsoft.SqlServer.Dts.Tasks.ScriptTask
Assembly: Microsoft.SqlServer.ScriptTask (in microsoft.sqlserver.scripttask.dll)

Syntax

'Declaration
Public Property ReadOnlyVariables As String

public string ReadOnlyVariables { get; set; }

public:
property String^ ReadOnlyVariables {
    String^ get ();
    void set (String^ value);
}

/** @property */
public String get_ReadOnlyVariables ()

/** @property */
public void set_ReadOnlyVariables (String value)

public function get ReadOnlyVariables () : String

public function set ReadOnlyVariables (value : String)

Property Value

The comma-delimited list of existing variables made available to the package by the user for read-only access.

Example

The following code sample, implemented in a console application, adds a ScriptTask to the package and displays the default values of some of its properties, including the ReadOnlyVariables property.

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

namespace ScriptTaskCS
{
  class Program
  {
    static void Main(string[] args)
    {
      Package pkg = new Package();
      string newLine = System.Environment.NewLine;

      Executable exe = pkg.Executables.Add("STOCK:ScriptTask");
      TaskHost thTask = (TaskHost)exe;

      string taskInfo;
      taskInfo = 
        "Project name: " + 
        thTask.Properties["VsaProjectName"].GetValue(thTask) + newLine + 
        "Entry point: " + 
        thTask.Properties["EntryPoint"].GetValue(thTask) + newLine + 
        "Script Language: " + 
        thTask.Properties["ScriptLanguage"].GetValue(thTask) + newLine + 
        "Precompiled?: " + 
        thTask.Properties["PreCompile"].GetValue(thTask) + newLine + 
        "ReadOnlyVariables: " + 
        thTask.Properties["ReadOnlyVariables"].GetValue(thTask) + newLine + 
        "ReadWriteVariables: " + 
        thTask.Properties["ReadWriteVariables"].GetValue(thTask);

      Console.WriteLine(taskInfo);
      Console.Read();
    }
  }
}

Imports Microsoft.SqlServer.Dts.Runtime

Module Module1

  Sub Main()

    Dim pkg As New Package
    Dim newLine As String = System.Environment.NewLine

    Dim exe As Executable = pkg.Executables.Add("STOCK:ScriptTask")
    Dim thTask As TaskHost = CType(exe, TaskHost)

    Dim taskInfo As String
    taskInfo = "Project name: " & _
      thTask.Properties("VsaProjectName").GetValue(thTask) & newLine & _
      "Entry point: " & _
      thTask.Properties("EntryPoint").GetValue(thTask) & newLine & _
      "Script Language: " & _
      thTask.Properties("ScriptLanguage").GetValue(thTask) & newLine & _
      "Precompiled?: " & _
      thTask.Properties("PreCompile").GetValue(thTask) & newLine & _
      "ReadOnlyVariables: " & _
      thTask.Properties("ReadOnlyVariables").GetValue(thTask) & newLine & _
      "ReadWriteVariables: " & _
      thTask.Properties("ReadWriteVariables").GetValue(thTask)

    Console.WriteLine(taskInfo)
    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

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

Share via