ExecuteSQLTask.IsStoredProcedure Property

Gets or sets a Boolean that indicates whether the SQL statement specified by the Execute SQL task is a stored procedure.

Namespace:  Microsoft.SqlServer.Dts.Tasks.ExecuteSQLTask
Assembly:  Microsoft.SqlServer.SQLTask (in Microsoft.SqlServer.SQLTask.dll)

Syntax

'Declaration
Public Property IsStoredProcedure As Boolean 
    Get 
    Set
'Usage
Dim instance As ExecuteSQLTask 
Dim value As Boolean 

value = instance.IsStoredProcedure

instance.IsStoredProcedure = value
public bool IsStoredProcedure { get; set; }
public:
virtual property bool IsStoredProcedure {
    bool get () sealed;
    void set (bool value) sealed;
}
abstract IsStoredProcedure : bool with get, set 
override IsStoredProcedure : bool with get, set
final function get IsStoredProcedure () : boolean 
final function set IsStoredProcedure (value : boolean)

Property Value

Type: System.Boolean
true if the SQL statement that the Execute SQL task executes is a stored procedure.

Implements

IDTSExecuteSQL.IsStoredProcedure

Remarks

The value of this property is always false, unless the task uses an ADO connection manager, as this property is only used by the runtime when using an ADO connection manager.

Examples

The following example creates an ExecuteSQLTask, and then outputs the default settings of the properties, including IsStoredProcedure, by using the TaskHost. The example 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

See Also

Reference

ExecuteSQLTask Class

Microsoft.SqlServer.Dts.Tasks.ExecuteSQLTask Namespace