WebPartPagesWebService.AssociateWorkflowMarkup Method
Creates a new SPWorkflowAssociation object list applied in the /WorkflowConfig/Association/@ListID attribute in the associated configuration file. If the /WorkflowConfig/Association/@ListID attribute is not applied, the method creates a new SPWorkflowAssociation object on the Windows SharePoint Services 3.0 Web site.
Namespace: [Webpartpages Web service]
Web service reference: http://Site/_vti_bin/Webpartpages.asmx
Syntax
'Declaration
<SoapDocumentMethodAttribute("https://microsoft.com/sharepoint/webpartpages/AssociateWorkflowMarkup", RequestNamespace := "https://microsoft.com/sharepoint/webpartpages", _
ResponseNamespace := "https://microsoft.com/sharepoint/webpartpages", _
Use := SoapBindingUse.Literal, ParameterStyle := SoapParameterStyle.Wrapped)> _
Public Function AssociateWorkflowMarkup ( _
configUrl As String, _
configVersion As String _
) As String
'Usage
Dim instance As WebPartPagesWebService
Dim configUrl As String
Dim configVersion As String
Dim returnValue As String
returnValue = instance.AssociateWorkflowMarkup(configUrl, _
configVersion)
[SoapDocumentMethodAttribute("https://microsoft.com/sharepoint/webpartpages/AssociateWorkflowMarkup", RequestNamespace = "https://microsoft.com/sharepoint/webpartpages",
ResponseNamespace = "https://microsoft.com/sharepoint/webpartpages",
Use = SoapBindingUse.Literal, ParameterStyle = SoapParameterStyle.Wrapped)]
public string AssociateWorkflowMarkup(
string configUrl,
string configVersion
)
Parameters
configUrl
Type: System.StringThe Web-relative URL for the configuration file in the configuration file format.
configVersion
Type: System.StringThe version number of the configuration file in the format NNNN.NNNN.
Return Value
Type: System.String
An "Error" or "Success" message. A "Success" message contains the GUID of the new SPWorkflowAssociation.
Exceptions
| Exception | Condition |
|---|---|
| SPWorkflowDisabledException | The workflow is disabled. |
| SPWorkflowExtendedFieldException | The site column does not exist. |
Remarks
This method modifies older versions of the specified workflow and sets a value that allows no new instances; all versions will share the same status column in the list.
Other properties that are defined in the configuration file include, but are not limited to, the following:
The name of the workflow.
The initiation parameters to use, as well as their default values.
The location of the XOML and the RULES, as well as which version to use for each.
The conditions under which the workflow starts.
To access the WebPartPagesWebService service and its methods, set a Web reference to http://Virtual_Server_Name:Port_Number/_vti_adm/WebPartPages.asmx.