WebServiceTask Class

 

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

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

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

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

NameDescription
System_CAPS_pubmethodWebServiceTask()

Initializes a new instance of the WebServiceTask class.

NameDescription
System_CAPS_pubpropertyConnection

Gets or sets the name of the connection to use.

System_CAPS_pubpropertyDebugMode

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.

System_CAPS_pubpropertyExecutionValue

Returns a user-defined object. This field is read-only. (Inherited from Task.)

System_CAPS_pubpropertyOutputLocation

Gets or sets the output location of the results of the Web method.

System_CAPS_pubpropertyOutputType

Gets or sets a value that indicates the storage location of the result of the Web method invocation.

System_CAPS_pubpropertyOverwriteWsdlFile

Gets or sets a value that indicates if the Web Services Description Language (WDSL) file will be overwritten.

System_CAPS_pubpropertyServiceName

Gets or sets the name of the Web service.

System_CAPS_pubpropertySuspendRequired

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.

System_CAPS_pubpropertyTargetServerVersion

(Inherited from Task.)

System_CAPS_pubpropertyVersion

*** Member deprecated; see Remarks. ***   Returns the version of the task. This property is read-only.(Inherited from Task.)

System_CAPS_pubpropertyWebMethodInfo

Gets or sets a DTSWebMethodInfo object.

System_CAPS_pubpropertyWsdlFile

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.

NameDescription
System_CAPS_pubmethodAcceptBreakpointManager(BreakpointManager)

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.

System_CAPS_pubmethodCanUpdate(String)

*** Member deprecated; see Remarks. ***   A Boolean that indicates whether the new package XML can update the old package XML.(Inherited from Task.)

System_CAPS_pubmethodEquals(Object)

Determines whether two object instances are equal.(Inherited from DtsObject.)

System_CAPS_pubmethodExecute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object)
System_CAPS_pubmethodGetConnectionID(Connections, String)

Gets a String containing the ID of the connection.(Inherited from Task.)

System_CAPS_pubmethodGetConnectionName(Connections, String)

Gets a String containing the name of the connection.(Inherited from Task.)

System_CAPS_pubmethodGetHashCode()

Returns the hash code for this instance.(Inherited from DtsObject.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodInitializeTask(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging, EventInfos, LogEntryInfos, ObjectReferenceTracker)

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).)

System_CAPS_pubmethodLoadFromXML(XmlElement, IDTSInfoEvents)

This method is not callable by your application code. To load a package saved as .xml, use the Application.LoadPackage method.

System_CAPS_pubmethodResumeExecution()

Resumes execution of the task after pausing. The task or container is resumed by the runtime engine.

System_CAPS_pubmethodSaveToXML(XmlDocument, IDTSInfoEvents)

This method is not callable by your application code. To save a package as .xml, use the Application.SaveToXml method.

System_CAPS_pubmethodSuspendExecution()

Indicates that the executable needs to suspend. This method is called by the runtime engine.

System_CAPS_pubmethodToString()

(Inherited from Object.)

System_CAPS_pubmethodUpdate(String)

*** 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.)

System_CAPS_pubmethodValidate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging)

Verifies that the web service component is properly configured.(Overrides Task.Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging).)

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

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

Return to top
Show: