ScriptTask.ReadOnlyVariables Property

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
    Get
    Set
'Usage
Dim instance As ScriptTask
Dim value As String

value = instance.ReadOnlyVariables

instance.ReadOnlyVariables = value

public string ReadOnlyVariables { get; set; }

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

member ReadOnlyVariables : string with get, set

function get ReadOnlyVariables () : String
function set ReadOnlyVariables (value : String)

Property Value

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

Examples

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 = 
        
        "Entry point: " + 
        thTask.Properties["EntryPoint"].GetValue(thTask) + newLine + 
        "Script Language: " + 
        thTask.Properties["ScriptLanguage"].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 = 
      
      "Entry point: " & _
      thTask.Properties("EntryPoint").GetValue(thTask) & newLine & _
      "Script Language: " & _
      thTask.Properties("ScriptLanguage").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

See Also

Reference

ScriptTask Class

Microsoft.SqlServer.Dts.Tasks.ScriptTask Namespace