ExecuteSQLTask.TimeOut Property

Article
12/15/2008

Gets or sets an integer that indicates the maximum number of seconds the task can run before timing out.

Espace de noms: Microsoft.SqlServer.Dts.Tasks.ExecuteSQLTask
Assembly: Microsoft.SqlServer.SQLTask (in microsoft.sqlserver.sqltask.dll)

Syntaxe

'Déclaration
Public Property TimeOut As UInteger

public uint TimeOut { get; set; }

public:
virtual property unsigned int TimeOut {
    unsigned int get () sealed;
    void set (unsigned int value) sealed;
}

/** @property */
public final UInt32 get_TimeOut ()

/** @property */
public final void set_TimeOut (UInt32 value)

public final function get TimeOut () : uint

public final function set TimeOut (value : uint)

Valeur de propriété

An Integer that indicates the maximum number of seconds the task can run before timing out.

Notes

A value of 0 indicates an infinite amount of time. The default value of this property is 0.

Exemple

The following example creates an ExecuteSQLTask, then shows the default settings of the properties, including the TimeOut, using the TaskHost. It then sets the value of some properties to show how to set property values.

using System;
using System.Collections.Generic;
using System.Text;
using Microsoft.SqlServer.Dts.Runtime;
using Microsoft.SqlServer.Dts.Tasks.ExecuteSQLTask;

namespace Microsoft.SqlServer.SSIS.Samples
{
    class Program
    {
        static void Main(string[] args)
        {
            Package pkg = new Package();
            Executable exec1 = pkg.Executables.Add("STOCK:SQLTask");
            TaskHost th = exec1 as TaskHost;

            // List the default values of the Execute SQL task
            // by using the Properties collection of the TaskHost.
            Console.WriteLine("BypassPrepare          {0}", th.Properties["BypassPrepare"].GetValue(th));
            Console.WriteLine("CodePage               {0}", th.Properties["CodePage"].GetValue(th));
            Console.WriteLine("Connection             {0}", th.Properties["Connection"].GetValue(th));
            Console.WriteLine("ExecutionValue         {0}", th.Properties["ExecutionValue"].GetValue(th));
            Console.WriteLine("IsStoredProcedure      {0}", th.Properties["IsStoredProcedure"].GetValue(th));
            Console.WriteLine("ParameterBindings      {0}", th.Properties["ParameterBindings"].GetValue(th));
            Console.WriteLine("ResultSetBindings      {0}", th.Properties["ResultSetBindings"].GetValue(th));
            Console.WriteLine("ResultSetType          {0}", th.Properties["ResultSetType"].GetValue(th));
            Console.WriteLine("SqlStatementSource     {0}", th.Properties["SqlStatementSource"].GetValue(th));
            Console.WriteLine("SqlStatementSourceType {0}", th.Properties["SqlStatementSourceType"].GetValue(th));
            Console.WriteLine("TimeOut                {0}", th.Properties["TimeOut"].GetValue(th));
            
            Console.WriteLine("--------------------------");
            // Show how to set a property by using the TaskHost properties.
            Variable myVar = pkg.Variables.Add("myVar", false, "User", 100);
            th.Properties["SqlStatementSourceType"].SetValue(th, SqlStatementSourceType.Variable);
            th.Properties["SqlStatementSource"].SetValue(th, "myVar");
            th.Properties["ResultSetType"].SetValue(th, ResultSetType.ResultSetType_XML);
            
            Console.WriteLine("New value of Source and SourceType:  {0}, {1}", th.Properties["SqlStatementSource"].GetValue(th), th.Properties["SqlStatementSourceType"].GetValue(th));
            Console.WriteLine("New value of ResultSetType:  {0}", th.Properties["ResultSetType"].GetValue(th), th.Properties["SqlStatementSourceType"].GetValue(th));

            Console.WriteLine();
        }
    }
}

Imports System
Imports System.Collections.Generic
Imports System.Text
Imports Microsoft.SqlServer.Dts.Runtime
Imports Microsoft.SqlServer.Dts.Tasks.ExecuteSQLTask
 
Namespace Microsoft.SqlServer.SSIS.Samples
    Class Program
        Shared  Sub Main(ByVal args() As String)
            Dim pkg As Package =  New Package() 
            Dim exec1 As Executable =  pkg.Executables.Add("STOCK:SQLTask") 
            Dim th As TaskHost =  exec1 as TaskHost 
 
            ' List the default values of the Execute SQL task
            ' by using the Properties collection of the TaskHost.
            Console.WriteLine("BypassPrepare          {0}", th.Properties("BypassPrepare").GetValue(th))
            Console.WriteLine("CodePage               {0}", th.Properties("CodePage").GetValue(th))
            Console.WriteLine("Connection             {0}", th.Properties("Connection").GetValue(th))
            Console.WriteLine("ExecutionValue         {0}", th.Properties("ExecutionValue").GetValue(th))
            Console.WriteLine("IsStoredProcedure      {0}", th.Properties("IsStoredProcedure").GetValue(th))
            Console.WriteLine("ParameterBindings      {0}", th.Properties("ParameterBindings").GetValue(th))
            Console.WriteLine("ResultSetBindings      {0}", th.Properties("ResultSetBindings").GetValue(th))
            Console.WriteLine("ResultSetType          {0}", th.Properties("ResultSetType").GetValue(th))
            Console.WriteLine("SqlStatementSource     {0}", th.Properties("SqlStatementSource").GetValue(th))
            Console.WriteLine("SqlStatementSourceType {0}", th.Properties("SqlStatementSourceType").GetValue(th))
            Console.WriteLine("TimeOut                {0}", th.Properties("TimeOut").GetValue(th))
 
            Console.WriteLine("--------------------------")
            ' Show how to set a property by using the TaskHost properties.
            Dim myVar As Variable =  pkg.Variables.Add("myVar",False,"User",100) 
            th.Properties("SqlStatementSourceType").SetValue(th, SqlStatementSourceType.Variable)
            th.Properties("SqlStatementSource").SetValue(th, "myVar")
            th.Properties("ResultSetType").SetValue(th, ResultSetType.ResultSetType_XML)
 
            Console.WriteLine("New value of Source and SourceType:  {0}, {1}", th.Properties("SqlStatementSource").GetValue(th), th.Properties("SqlStatementSourceType").GetValue(th))
            Console.WriteLine("New value of ResultSetType:  {0}", th.Properties("ResultSetType").GetValue(th), th.Properties("SqlStatementSourceType").GetValue(th))
 
            Console.WriteLine()
        End Sub
    End Class
End Namespace

Sample Output:

BypassPrepare False

CodePage 1252

Connection

ExecutionValue

IsStoredProcedure False

ParameterBindings Microsoft.SqlServer.Dts.Tasks.ExecuteSQLTask.ParameterBindings

ResultSetBindings Microsoft.SqlServer.Dts.Tasks.ExecuteSQLTask.ResultBindings

ResultSetType 1

SqlStatementSource

SqlStatementSourceType 1

TimeOut 0

--------------------------

New value of Source and SourceType: myVar, 3

New value of ResultSetType: 4

Sécurité des threads

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.

Plateformes

Plateformes de développement

Pour obtenir la liste des plateformes prises en charge, consultez Configuration matérielle et logicielle requise pour l'installation de SQL Server 2005.

Plateformes cibles