WebServiceTask Class

Article
04/26/2013

Runs a Web method and stores the result in a specified location. This class cannot be inherited.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Dts.Runtime.DtsObject
    Microsoft.SqlServer.Dts.Runtime.Task
      Microsoft.SqlServer.Dts.Tasks.WebServiceTask.WebServiceTask

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

Syntax

'Declaration
Public NotInheritable Class WebServiceTask _
    Inherits Task _
    Implements IDTSComponentPersist, IDTSWebServiceTask, IDTSBreakpointSite, IDTSSuspend
'Usage
Dim instance As WebServiceTask

public sealed class WebServiceTask : Task, 
    IDTSComponentPersist, IDTSWebServiceTask, IDTSBreakpointSite, IDTSSuspend

public ref class WebServiceTask sealed : public Task, 
    IDTSComponentPersist, IDTSWebServiceTask, IDTSBreakpointSite, IDTSSuspend

[<SealedAttribute>]
type WebServiceTask =  
    class 
        inherit Task 
        interface IDTSComponentPersist 
        interface IDTSWebServiceTask 
        interface IDTSBreakpointSite 
        interface IDTSSuspend 
    end

public final class WebServiceTask extends Task implements IDTSComponentPersist, IDTSWebServiceTask, IDTSBreakpointSite, IDTSSuspend

The WebServiceTask type exposes the following members.

Constructors

	Name	Description
	WebServiceTask	Initializes a new instance of the WebServiceTask class.

Top

Properties

	Name	Description
	Connection	Gets or sets the name of the connection to use.
	DebugMode	Gets or sets a Boolean that indicates if the task is in debug mode. The DebugMode property can be accessed by multiple threads at the same time. To ensure thread safety and avoid concurrency problems, the Interlocked class from the Microsoft .NET Framework is used.
	ExecutionValue	Returns a user-defined object. This field is read-only. (Inherited from Task.)
	OutputLocation	Gets or sets the output location of the results of the Web method.
	OutputType	Gets or sets a value that indicates the storage location of the result of the Web method invocation.
	OverwriteWsdlFile	Gets or sets a value that indicates if the Web Services Description Language (WDSL) file will be overwritten.
	ServiceName	Gets or sets the name of the Web service.
	SuspendRequired	Gets or sets a Boolean that indicates if tasks should suspend when they encounter a breakpoint. This value is set by the runtime engine for tasks and containers when a breakpoint is encountered.
	Version	* Member deprecated; see Remarks. * Returns the version of the task. This property is read-only. (Inherited from Task.)
	WebMethodInfo	Gets or sets a DTSWebMethodInfo object.
	WsdlFile	Gets or sets the name of a Web Services Description Language (WSDL) file that is to be read from either a file URL or an HTTP URL.

Top

Methods

	Name	Description
	AcceptBreakpointManager	Passes a BreakpointManager to the task. The task will use the breakpoint manager to create, remove, and check the status of breakpoints. This method is called by the runtime and is not used in code.
	CanUpdate	* Member deprecated; see Remarks. * A Boolean that indicates whether the new package XML can update the old package XML. (Inherited from Task.)
	Equals	Determines whether two object instances are equal. (Inherited from DtsObject.)
	Execute	Runs the web service task. (Overrides Task.Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object).)
	GetConnectionID	Gets a String containing the ID of the connection. (Inherited from Task.)
	GetConnectionName	Gets a String containing the name of the connection. (Inherited from Task.)
	GetHashCode	Returns the hash code for this instance. (Inherited from DtsObject.)
	GetType	(Inherited from Object.)
	InitializeTask	Initializes the properties associated with the web service task. This method is called by the runtime and is not used in code. (Overrides Task.InitializeTask(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging, EventInfos, LogEntryInfos, ObjectReferenceTracker).)
	LoadFromXML	This method is not callable by your application code. To load a package saved as .xml, use the Application.LoadPackage method.
	ResumeExecution	Resumes execution of the task after pausing. The task or container is resumed by the runtime engine.
	SaveToXML	This method is not callable by your application code. To save a package as .xml, use the Application.SaveToXml method.
	SuspendExecution	Indicates that the executable needs to suspend. This method is called by the runtime engine.
	ToString	(Inherited from Object.)
	Update	* Member deprecated; see Remarks. * This method updates the old package XML with the new package XML if CanUpdate is set to true. (Inherited from Task.)
	Validate	Verifies that the web service component is properly configured. (Overrides Task.Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging).)

Top

Remarks

Using the WebServiceTask class, the task designer can execute a Web method and store the results in a package variable or a file.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Share via